Emoji and Icons
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.
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 |
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
|
Emoji and Name Cheet Sheet
People
|
|
|
Nature
|
|
|
Objects
|
[emoji gift-heart not found] |
|
Places
[emoji aerial-tramway not found] |
|
|
Symbols
|
|
|