How to use icons in the wiki

You can use any font awesome icon listed at https://fontawesome.com/v4.7.0/icons/ in your wiki documents by use of the icon macro.

Syntax for inserting icons
icon:thumbs-up []
icon:database[role=green] // change color by use of the role syntax
icon:heart[2x] // icons can be sized
icon:shield[rotate=90, flip=vertical] // rotate and flip

When setting the icons name, you do not have to preface it with fa-, asciidoctor will accept the font name.

The icon macro has three attributes you can set, they are size, rotate, and flip.

  • size

    • The first positional attribute found, scales the icon; values are: 1x (default), 2x, 3x, 4x, 5x, lg, fw

    • You can fix the width of the icon by use of the fw attribute. This helps when trying to align with other elements by giving the icon a fixed width.

  • rotate

    • Rotates the icon; values are: 90, 180, 270

  • flip

    • Flips the icon; values are: horizontal, vertical

The first unnamed attribute is assumed to be the size. For instance, to make the icon twice the size as the default, simply add 2x inside the square brackets.

icon:heart[2x]

Results:

2x

To rotate and flip the icon:

icon:shield[rotate=270, flip=vertical]

Results:

rotated 90, and flipped vertical

You can also link to icons.

icon:download[link="https://rubygems.org/downloads/asciidoctor-1.5.2.gem"]

Results:

Lastly, you can color your icons using the role syntax.

icon:database[role=green]

Results:

colored green

How to use emoji in the wiki

Using emoji in wiki docs currently requires the setting of the :stylesheet: attribute in the header of the wiki document.

:stylesheet: twemoji-awesome.css

The Anatomy of a Wiki Header document explains setting of this and other header attributes.

Once the header attribute is set, you can add the emoji using the following syntax.

emoji:heart[2x] // the "[2x]" is a size modifier
emoji:rage[]

You can change the icon size with the size modifier [2x].

emoji:heart[] emoji:heart[2x]

Emoji and Name Cheet Sheet

People

smile
smiley
heart-eyes
flushed
grin
stuck-out-tongue-closed-eyes
kissing-smiling-eyes
worried
open-mouth
hushed
sweat-smile
pensive
fearful
cry
astonished
angry
sleepy
sunglasses
smiling-imp
innocent
blue-heart
green-heart
heartpulse
cupid
star
boom
question
zzz
notes
poop
ok-hand
v
open-hands
point-left
pray
muscle
couple
dancers
information-desk-person
person-with-pouting-face
couplekiss
haircut
girl
baby
person-with-blond-hair
construction-worker
princess
heart-eyes-cat
scream-cat
pouting-cat
see-no-evil
guardsman
lips
ear
tongue
busts-in-silhouette

laughing
relaxed
kissing-heart
relieved
wink
grinning
stuck-out-tongue
frowning
grimacing
expressionless
sweat
disappointed
cold-sweat
sob
scream
rage
yum
dizzy-face
neutral-face
alien
purple-heart
broken-heart
two-hearts
sparkling-heart
star2
anger
grey-exclamation
dash
musical-note
thumbsup
punch
wave
point-up
point-right
point-up-2
walking
family
ok-woman
raised-hand
person-frowning
couple-with-heart
nail-care
woman
older-woman
man-with-gua-pi-mao
cop
smiley-cat
kissing-cat
crying-cat-face
japanese-ogre
hear-no-evil
skull
kiss
eyes
love-letter
speech-balloon

blush
smirk
kissing-closed-eyes
satisfied
stuck-out-tongue-winking-eye
kissing
sleeping
anguished
confused
unamused
weary
confounded
persevere
joy
tired-face
triumph
mask
imp
no-mouth
yellow-heart
heart
heartbeat
revolving-hearts
sparkles
dizzy
exclamation
grey-question
sweat-drops
fire
thumbsdown
fist
hand
point-down
raised-hands
clap
runner
dancer
no-good
bride-with-veil
bow
massage
boy
man
older-man
man-with-turban
angel
smile-cat
smirk-cat
joy-cat
japanese-goblin
speak-no-evil
feet
droplet
nose
bust-in-silhouette
thought-balloon

Nature

sunny
snowflake
cyclone
cat
hamster
frog
bear
cow
monkey
camel
panda-face
baby-chick
chicken
bug
beetle
tropical-fish
whale2
ram
tiger2
goat
pig2
dragon-face
dromedary-camel
poodle
cherry-blossom
rose
maple-leaf
herb
palm-tree
chestnut
ear-of-rice
sun-with-face
new-moon
waxing-gibbous-moon
last-quarter-moon
first-quarter-moon-with-face
earth-americas
milky-way

umbrella
snowman
foggy
dog
rabbit
tiger
pig
boar
horse
sheep
snake
hatched-chick
penguin
honeybee
snail
fish
dolphin
rat
rabbit2
rooster
mouse2
blowfish
leopard
paw-prints
tulip
sunflower
leaves
mushroom
evergreen-tree
seedling
shell
full-moon-with-face
waxing-crescent-moon
full-moon
waning-crescent-moon
moon
earth-asia
partly-sunny

cloud
zap
ocean
mouse
wolf
koala
pig-nose
monkey-face
racehorse
elephant
bird
hatching-chick
turtle
ant
octopus
whale
cow2
water-buffalo
dragon
dog2
ox
crocodile
cat2
bouquet
four-leaf-clover
hibiscus
fallen-leaf
cactus
deciduous-tree
blossom
globe-with-meridians
new-moon-with-face
first-quarter-moon
waning-gibbous-moon
last-quarter-moon-with-face
earth-africa
volcano

Objects

bamboo
school-satchel
fireworks
rice-scene
santa
apple
balloon
baseball
bathtub
beers
bicyclist
black-joker
bomb
books
bread
cake
camera
cd
cherries
clapper
closed-lock-with-key
cocktail
confetti-ball
credit-card
curry
dart
dollar
dress
egg
email
fax
fishing-pole-and-fish
flower-playing-cards
fried-shrimp
gem
grapes
guitar
hammer
hearts
hocho
hourglass
icecream
iphone
kimono
lipstick
lollipop
low-brightness
mahjong
mailbox-with-mail
meat-on-bone
memo
minidisc
mountain-bicyclist
musical-score
necktie
notebook
oden
outbox-tray
pager
pear
pill
postal-horn
poultry-leg
pushpin
ribbon
rice-cracker
running-shirt-with-sash
satellite
scroll
shirt
smoking
sound
spaghetti
straight-ruler
sushi
syringe
tangerine
telescope
tomato
trophy
tv
video-camera
watch
womans-clothes
yen

gift-heart
mortar-board
sparkler
jack-o-lantern
8ball
art
banana
basketball
battery
bell
bikini
black-nib
bookmark
boot
briefcase
calendar
candy
chart-with-downwards-trend
chocolate-bar
clipboard
closed-umbrella
coffee
cookie
crown
custard
date
door
dvd
eggplant
euro
file-folder
flashlight
football
fries
gift
green-apple
gun
handbag
high-brightness
honey-pot
hourglass-flowing-sand
inbox-tray
jeans
ledger
lock
loop
mag
mailbox
mailbox-with-no-mail
mega
microphone
money-with-wings
movie-camera
mute
newspaper
notebook-with-decorative-cover
open-file-folder
page-facing-up
paperclip
pencil2
pineapple
postbox
pound
radio
rice
ring
sake
saxophone
seat
shower
snowboarder
space-invader
speaker
strawberry
sweet-potato
tada
tea
tennis
tophat
tropical-drink
unlock
video-game
watermelon
womans-hat

dolls
flags
wind-chime
ghost
alarm-clock
baby-bottle
bar-chart
bath
beer
bento
birthday
blue-book
bookmark-tabs
bowling
bulb
calling
card-index
chart-with-upwards-trend
christmas-tree
closed-book
clubs
computer
corn
crystal-ball
dango
diamonds
doughnut
e-mail
electric-plug
eyeglasses
fish-cake
floppy-disk
fork-and-knife
game-die
golf
green-book
hamburger
headphones
high-heel
horse-racing
ice-cream
incoming-envelope
key
lemon
lock-with-ink-pen
loudspeaker
mag-right
mailbox-closed
mans-shoe
melon
microscope
moneybag
musical-keyboard
name-badge
no-bell
nut-and-bolt
orange-book
page-with-curl
peach
phone
pizza
pouch
purse
ramen
rice-ball
rugby-football
sandal
scissors
shaved-ice
ski
soccer
spades
stew
surfer
swimmer
tanabata-tree
telephone-receiver
toilet
triangular-ruler
trumpet
vhs
violin
wine-glass
wrench

Places

aerial-tramway
anchor
bank
bike
bridge-at-night
bus
carousel-horse
circus-tent
construction
department-store
factory
fountain
hospital
house
japanese-castle
minibus
mountain-cableway
office
oncoming-police-car
police-car
rainbow
rotating-light
school
speedboat
statue-of-liberty
sunrise-over-mountains
tent
tractor
tram
truck
wedding
cn
es
gb

airplane
articulated-lorry
barber
blue-car
bullettrain-front
busstop
checkered-flag
city-sunrise
convenience-store
european-castle
ferris-wheel
fuelpump
hotel
house-with-garden
light-rail
monorail
mountain-railway
oncoming-automobile
oncoming-taxi
post-office
rocket
round-pushpin
ship
stars
steam-locomotive
suspension-railway
ticket
traffic-light
triangular-flag-on-post
vertical-traffic-light
jp
us
it
de

ambulance
atm
beginner
boat
bullettrain-side
car
church
city-sunset
crossed-flags
european-post-office
fire-engine
helicopter
hotsprings
japan
love-hotel
mount-fuji
moyai
oncoming-bus
performing-arts
railway-car
roller-coaster
rowboat
slot-machine
station
sunrise
taxi
tokyo-tower
train2
trolleybus
warning
kr
fr
ru

Symbols

100
ab
accept
arrow-backward
arrow-down
arrow-heading-down
arrow-lower-left
arrow-right-hook
arrow-up-small
arrows-clockwise
baby-symbol
bangbang
cancer
chart
cl
clock1030
clock12
clock2
clock330
clock5
clock630
clock8
clock930
copyright
customs
eight
end
four
hash
heavy-division-sign
heavy-multiplication-x
ideograph-advantage
keycap-ten
large-blue-diamond
left-right-arrow
libra
mens
negative-squared-cross-mark
nine
no-entry-sign
no-smoking
o2
one
part-alternation-mark
potable-water
recycle
repeat
rewind
scorpius
signal-strength
small-blue-diamond
small-red-triangle-down
symbols
tm
twisted-rightwards-arrows
u5408
u6708
u7121
u7a7a
vibration-mode
wavy-dash
white-check-mark
white-square-button
zero

1234
abc
aquarius
arrow-double-down
arrow-down-small
arrow-heading-up
arrow-lower-right
arrow-up
arrow-upper-left
arrows-counterclockwise
baggage-claim
black-circle
capital-abcd
children-crossing
clock1
clock11
clock1230
clock230
clock4
clock530
clock7
clock830
congratulations
curly-loop
diamond-shape-with-a-dot-inside
eight-pointed-black-star
fast-forward
free
heart-decoration
heavy-dollar-sign
heavy-plus-sign
information-source
koko
large-orange-diamond
leftwards-arrow-with-hook
link
metro
new
no-bicycles
no-mobile-phones
non-potable-water
ok
ophiuchus
passport-control
put-litter-in-its-place
red-circle
repeat-one
sa
secret
six
small-orange-diamond
soon
taurus
top
two
u55b6
u6709
u7533
underage
virgo
wc
white-circle
womens

a
abcd
aries
arrow-double-up
arrow-forward
arrow-left
arrow-right
arrow-up-down
arrow-upper-right
b
ballot-box-with-check
black-square-button
capricorn
cinema
clock10
clock1130
clock130
clock3
clock430
clock6
clock730
clock9
cool
currency-exchange
do-not-litter
eight-spoked-asterisk
five
gemini
heavy-check-mark
heavy-minus-sign
id
interrobang
large-blue-circle
left-luggage
leo
m
mobile-phone-off
ng
no-entry
no-pedestrians
o
on
parking
pisces
radio-button
registered
restroom
sagittarius
seven
six-pointed-star
small-red-triangle
sos
three
trident
u5272
u6307
u6e80
u7981
up
vs
wheelchair
white-flower
x