From f0abba3550da90ad04dff994cd57ef6194e2becb Mon Sep 17 00:00:00 2001 From: Sarah White Date: Thu, 5 Apr 2018 12:04:05 -0600 Subject: [PATCH] move admonition styles to a new page --- docs/modules/ROOT/pages/admonition-styles.adoc | 41 ++++++++++++++++++++++++++ docs/modules/ROOT/pages/style-guide.adoc | 36 ++-------------------- 2 files changed, 44 insertions(+), 33 deletions(-) create mode 100644 docs/modules/ROOT/pages/admonition-styles.adoc 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] +---- +
+ + + + + +
+ + +
+

Watch out!

+
+
+
+---- + +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] ----- -
- - - - - -
- - -
-

Watch out!

-
-
-
----- - -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 -- 2.11.0