diff options
| author | Sarah White <graphitefriction@gmail.com> | 2018-04-05 12:04:05 -0600 |
|---|---|---|
| committer | Sarah White <graphitefriction@gmail.com> | 2018-04-10 10:31:36 -0600 |
| commit | f0abba3550da90ad04dff994cd57ef6194e2becb (patch) | |
| tree | 9e8f2c0d7e463ddd1a877583bf5e68f8acac233d /docs/modules/ROOT/pages | |
| parent | 396bf63eae4f60a557cf6efd4638e27d5172d511 (diff) | |
| download | alpine-antora-theme-f0abba3550da90ad04dff994cd57ef6194e2becb.tar.bz2 alpine-antora-theme-f0abba3550da90ad04dff994cd57ef6194e2becb.tar.xz | |
move admonition styles to a new page
Diffstat (limited to 'docs/modules/ROOT/pages')
| -rw-r--r-- | docs/modules/ROOT/pages/admonition-styles.adoc | 41 | ||||
| -rw-r--r-- | docs/modules/ROOT/pages/style-guide.adoc | 36 |
2 files changed, 44 insertions, 33 deletions
diff --git a/docs/modules/ROOT/pages/admonition-styles.adoc b/docs/modules/ROOT/pages/admonition-styles.adoc new file mode 100644 index 0000000..86b2cdc --- /dev/null +++ b/docs/modules/ROOT/pages/admonition-styles.adoc @@ -0,0 +1,41 @@ += Admonition Styles +ifndef::env-site,env-github[] +include::_attributes.adoc[] +endif::[] + +An xref:antora:asciidoc:admonitions.adoc[admonition], also known as a notice, helps draw attention to content with a special label or icon. + +== Admonition blocks + +An admonition block is a table. +The table title element is specified by the block class: tip, note, important, warning, or caution. +Here's an AsciiDoc source example that produces an admonition with the table title warning: + +[source,asciidoc] +---- +WARNING: Watch out! +---- + +If font-based icons are enabled (`icons=font`), the table title text is replaced by the associated icon. + +[source,html] +---- +<div class="admonitionblock warning"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-warning" title="Warning"></i> +</td> +<td class="content"> +<div class="paragraph"> +<p>Watch out!</p> +</div> +</td> +</tr> +</table> +</div> +---- + +Here's how it might appear when the title is displayed as text: + +WARNING: Watch out! diff --git a/docs/modules/ROOT/pages/style-guide.adoc b/docs/modules/ROOT/pages/style-guide.adoc index d9d6356..cea71c7 100644 --- a/docs/modules/ROOT/pages/style-guide.adoc +++ b/docs/modules/ROOT/pages/style-guide.adoc @@ -16,40 +16,10 @@ This document identifies these UI elements. The HTML in the main content area is generated from AsciiDoc using Asciidoctor. AsciiDoc has numerous content elements that require assistance from CSS to render properly. -=== Admonitions +These elements include: -An admonition block is a table. -The table title element is specified by the block class: tip, note, important, warning, or caution. -Here's an AsciiDoc source example that produces an admonition with the table title warning: - -[source,asciidoc] ----- -WARNING: Watch out! ----- - -If font-based icons are enabled (`icons=font`), the table title text is replaced by the associated icon. - -[source,html] ----- -<div class="admonitionblock warning"> -<table> -<tr> -<td class="icon"> -<i class="fa icon-warning" title="Warning"></i> -</td> -<td class="content"> -<div class="paragraph"> -<p>Watch out!</p> -</div> -</td> -</tr> -</table> -</div> ----- - -Here's how it might appear when the title is displayed as text: - -WARNING: Watch out! +* xref:inline-text-styles.adoc[Emphasized inline text, such as bold, italics, etc.] +* xref:admonition-styles.adoc[Admonitions] === Ordered List Numeration Styles |