On this page, you’ll learn:
How to mark up an example block with AsciiDoc.
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. Normal substitutions are applied to example content.
If the example content is contiguous, i.e., not interrupted by empty lines, the block style name
example can be placed directly on top of the text in an attribute list (
.Optional title [example] This is an example of an example block.
The result of Example 1 is displayed below.
If the example content includes multiple blocks or content separated by empty lines, place the content between delimiter lines consisting of four equals signs (
You don’t need to set the block style name when you use the example delimiters.
.Onomatopoeia ==== The book hit the floor with a *thud*. He could hear doves *cooing* in the pine trees`' branches. ====
The result of Example 2 is displayed below.
The book hit the floor with a thud.
He could hear doves cooing in the pine trees’ branches.
|Complex admonitions use the delimited example syntax.|