|
|
@@ -1,4 +1,4 @@
|
|
|
-= Emoji Cheat Sheet
|
|
|
+= Emoji and Icons
|
|
|
:author: mitm
|
|
|
:revnumber: 1.0
|
|
|
:stylesheet: twemoji-awesome.css
|
|
|
@@ -27,7 +27,67 @@ You can change the icon size with the size modifier `[2x]`.
|
|
|
`+emoji:heart[]+` emoji:heart[] `+emoji:heart[2x]+` emoji:heart[2x]
|
|
|
====
|
|
|
|
|
|
-== Emoji and Name
|
|
|
+== How to use icons in the wiki
|
|
|
+
|
|
|
+You can use any font awesome icon listed at link:https://fontawesome.com/v4.7.0/icons/[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
|
|
|
+```
|
|
|
+
|
|
|
+[TIP]
|
|
|
+====
|
|
|
+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:
|
|
|
+
|
|
|
+icon:heart[] 2x icon:heart[2x]
|
|
|
+
|
|
|
+To rotate and flip the icon:
|
|
|
+```
|
|
|
+icon:shield[rotate=270, flip=vertical]
|
|
|
+```
|
|
|
+Results:
|
|
|
+
|
|
|
+icon:shield[] rotated 90, and flipped vertical icon:shield[rotate=90, flip=vertical]
|
|
|
+
|
|
|
+You can also link to icons.
|
|
|
+```
|
|
|
+icon:download[link="https://rubygems.org/downloads/asciidoctor-1.5.2.gem"]
|
|
|
+```
|
|
|
+Results:
|
|
|
+
|
|
|
+icon:download[link="https://rubygems.org/downloads/asciidoctor-1.5.2.gem"]
|
|
|
+
|
|
|
+Lastly, you can color your icons using the role syntax.
|
|
|
+```
|
|
|
+icon:database[role=green]
|
|
|
+```
|
|
|
+Results:
|
|
|
+
|
|
|
+icon:database[] colored green icon:database[role=green]
|
|
|
+
|
|
|
+== Emoji and Name Cheet Sheet
|
|
|
|
|
|
=== People
|
|
|
|
mitm