diff options
| author | Sarah White <graphitefriction@gmail.com> | 2018-04-05 12:39:52 -0600 |
|---|---|---|
| committer | Sarah White <graphitefriction@gmail.com> | 2018-04-10 10:31:36 -0600 |
| commit | f2c6ad431ea892d25c13aeb424ffbbfb07e22f22 (patch) | |
| tree | 458f38bfb09599cff6a5eb967ce04cdfecf4f8e8 /docs/modules/ROOT/pages | |
| parent | 63cf3a5e8076fd401c4d22897e238c5f77c3002e (diff) | |
| download | alpine-antora-theme-f2c6ad431ea892d25c13aeb424ffbbfb07e22f22.tar.bz2 alpine-antora-theme-f2c6ad431ea892d25c13aeb424ffbbfb07e22f22.tar.xz | |
fix ui macro example error
Diffstat (limited to 'docs/modules/ROOT/pages')
| -rw-r--r-- | docs/modules/ROOT/pages/style-guide.adoc | 4 | ||||
| -rw-r--r-- | docs/modules/ROOT/pages/ui-macro-styles.adoc | 10 |
2 files changed, 6 insertions, 8 deletions
diff --git a/docs/modules/ROOT/pages/style-guide.adoc b/docs/modules/ROOT/pages/style-guide.adoc index 0c0e72c..94795cd 100644 --- a/docs/modules/ROOT/pages/style-guide.adoc +++ b/docs/modules/ROOT/pages/style-guide.adoc @@ -18,8 +18,8 @@ AsciiDoc has numerous content elements that require assistance from CSS to rende These elements include: -* xref:inline-text-styles.adoc[Emphasized inline text, such as bold, italics, etc.] +* xref:inline-text-styles.adoc[Inline text emphasis] * xref:admonition-styles.adoc[Admonitions] * xref:list-styles.adoc[Lists] * xref:sidebar-styles.adoc[Sidebars] -* xref:ui-macro-styles.adoc[Button, Keybinding, and Menu UI Macros] +* xref:ui-macro-styles.adoc[Button, keybinding, and menu UI macros] diff --git a/docs/modules/ROOT/pages/ui-macro-styles.adoc b/docs/modules/ROOT/pages/ui-macro-styles.adoc index 7024165..f04e485 100644 --- a/docs/modules/ROOT/pages/ui-macro-styles.adoc +++ b/docs/modules/ROOT/pages/ui-macro-styles.adoc @@ -3,8 +3,6 @@ ifndef::env-site,env-github[] include::_attributes.adoc[] endif::[] -== UI macro elements - Asciidoctor supports xref:antora:asciidoc:ui-macros.adoc[three UI element representations] out of the box, which are made from corresponding inline UI macros. * button (btn macro) @@ -14,7 +12,7 @@ Asciidoctor supports xref:antora:asciidoc:ui-macros.adoc[three UI element repres The UI elements are output using semantic HTML elements, so they inherit some default styling from the browser. However, to look proper, they require some additional styling. -=== Button +== Button A xref:antora:asciidoc:ui-macros.adoc#button[button] is meant to represent an on-screen button (`+btn:[Save]+`). However, it should not appear like an actual button as that could confuse the reader into thinking it's interactive. @@ -29,7 +27,7 @@ Traditionally, a button reference is styled by surrounding the text with square btn:[Save] -=== Keybinding +== Keybinding A xref:antora:asciidoc:ui-macros.adoc#keybinding[keybinding] can be a single key (`+kbd:[F11]+`) or a sequence of keys (`+kbd:[Ctrl+F]`). Here's the HTML that's generated for these two forms. @@ -46,7 +44,7 @@ Here's how these might appear: kbd:[F11] kbd:[Ctrl+F] -=== Menu +== Menu A xref:antora:asciidoc:ui-macros.adoc#menu[menu] can be a top-level menu reference (`+menu:File[]+`) or a nested selection (`+menu:File[Save]+`). Here's the HTML that's generated for these two forms. @@ -59,8 +57,8 @@ Here's the HTML that's generated for these two forms. This might be rendered as: -[%hardbreaks] menu:File[] + menu:File[Save] The default styling applied to a menu reference is usually sufficient. |