Admonitions
AsciiDoc admonitions are special callout blocks that highlight important information in documentation using distinct visual styles and icons.
Admonition types
There are certain statements you may want to draw attention to by taking them out of the content’s flow and labeling them with a priority. These are called admonitions.
[NOTE|TIP|IMPORTANT|CAUTION|WARNING]
Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture.
Ornateness bland it ex enc, est yeti am bongo detract re.Example
|
Note
|
Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture. Ornateness bland it ex enc, est yeti am bongo detract re. |
|
Tip
|
Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture. Ornateness bland it ex enc, est yeti am bongo detract re. |
|
Important
|
Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture. Ornateness bland it ex enc, est yeti am bongo detract re. |
|
Caution
|
Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture. Ornateness bland it ex enc, est yeti am bongo detract re. |
|
Warning
|
Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture. Ornateness bland it ex enc, est yeti am bongo detract re. Romanesque acclimates investiture. |
Admonition icons
Icons can be added by setting a unicode glyph or a character reference to the tip-caption attribute:
:tip-caption: 💡
[TIP]
It's possible to use Unicode glyphs as admonition icons.:tip-caption: pass:[🔥]
[TIP]
It's possible to use Unicode glyphs as admonition icons.Example
|
💡
|
It’s possible to use Unicode glyphs as admonition icons. |
|
🔥
|
It’s possible to use Unicode glyphs as admonition icons. |