11= Icons
22
3- The Couchbase documentation uses https://fontawesome.com/v4/icons/[Font Awesome V4^] icons rendered with the Antora `icon:[]` macro.
3+ The Couchbase documentation uses Font Awesome V4 icons.
4+ To find the correct icon name, search the https://fontawesome.com/v4/icons/[Font Awesome V4 icon library^].
45
5- To render an icon, use `icon:` followed by the Font Awesome icon name and empty square brackets:
6+ To render an icon, use the Antora `icon:` macro followed by the Font Awesome icon name and square brackets:
67
78----
89icon:fontawesome-icon[]
910----
1011
11- When you need to describe a clickable icon in the UI:
12+ If the Font Awesome icon has hyphens, write it as listed.
13+ For example, the circle with a plus sign icon icon:plus-circle[] is written as:
14+
15+ ----
16+ icon:plus-circle[]
17+ ----
18+
19+ TIP: To fix your icon's width and keep text aligned in vertical lists, writer `fw` in the square brackets.
20+
21+ To describe a clickable icon in the UI:
1222
1323* If the icon has a text label, refer to it by its label, followed by the icon in parentheses.
1424For example:
@@ -17,7 +27,9 @@ For example:
1727Click *Copy* (icon:copy[]).
1828----
1929+
20- This renders as: Click *Copy* (icon:copy[]).
30+ This renders as:
31+ +
32+ Click *Copy* (icon:copy[]).
2133
2234* If the icon has no text label, refer to it by the icon alone.
2335For example:
@@ -26,11 +38,6 @@ For example:
2638Click icon:copy[].
2739----
2840+
29- This renders as: Click icon:copy[].
30-
31- == Finding Icon Names
32-
33- To find the correct icon name, search the https://fontawesome.com/v4/icons/[Font Awesome V4 icon library^].
34- Use the name as listed, with hyphens, to the `icon:[]` macro.
35-
36- For example, the *trash* icon uses `icon:trash[]` and the *download* icon uses `icon:download[]`.
41+ This renders as:
42+ +
43+ Click icon:copy[].
0 commit comments