Blocks and other elements
Horizontal rule
A line with three single quotation marks (i.e., ''') is a special macro that inserts a thematic break (aka horizontal rule):
Horizontal rules shouldn’t be required in the normal course of writing documentation. However, they are an optional tool available in AsciiDoc that can be used to visually separate content in a pinch.
Example block
An example block is useful for visually delineating content that illustrates a concept or showing the result of an operation.
An example can contain any type of content and AsciiDoc syntax.
Here’s a sample AsciiDoc document:
= Title of Document
Doc Writer
:toc:
This guide provides...The document header is useful, but not required.
Blockquote
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris eget leo nunc, nec tempus mi? Curabitur id nisl mi, ut vulputate urna. Quisque porta facilisis tortor, vitae bibendum velit fringilla vitae! Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris eget leo nunc, nec tempus mi? Curabitur id nisl mi, ut vulputate urna. Quisque porta facilisis tortor, vitae bibendum velit fringilla vitae!
Cum dicat putant ne. Famous Person Website
Equations and formulas (STEM)
|
The AsciiDoc language supports embedding math-mode macros from LaTeX and/or AsciiMath notation as block or inline elements. These elements act as passthroughs to preserve the expressions as entered. The expressions are then passed on to the converter to be processed and rendered for display using a STEM provider (e.g., MathJax). Although AsciiDoc supports STEM at the language level, the STEM provider must be configured in the output converter to render the expressions. See the discussion in Antora Issue #184 to learn more about the requirements for configuring STEM in Antora. |