Admonitions

The Five Admonition Types

With admonitions, you emphasize certain information. In AsciiDoc, there are five types of admonitions:

Syntax Meaning

NOTE:

General note or information

TIP:

Helpful tip or recommendation

IMPORTANT:

Important information

CAUTION:

Caution – something could go wrong

WARNING:

Warning – danger or critical information

The syntax is simple – write the type followed by a colon and your text:

NOTE: This is a general note.

TIP: Here's a helpful tip for you.

WARNING: Caution, this action cannot be undone!

Displaying Admonitions as Icons

By default, admonitions are displayed as text (e.g., "Note:" or "Warning:"). You can replace the text with an icon by setting the :icons: font attribute in the document header.

This is a note with an icon.
This is a tip with an icon.
This is a warning with an icon.
Caution is advised here.
This is important to know.

Customizing admonition text: If you want to change the label, use the corresponding caption attributes. With :warning-caption: Attention, for example, "Warning" is replaced by "Attention".

Block Admonitions

For longer admonitions with multiple paragraphs or lists, use the block syntax:

[NOTE]
====
This admonition can contain multiple paragraphs.

It can also include lists:

* Point 1
* Point 2

Or even code blocks.
====

This admonition can contain multiple paragraphs.

It can also include lists:

  • Point 1

  • Point 2