Admonitions (:::warning, etc.)
Admonitions are callout boxes that set a block of content apart from the surrounding prose to signal its importance or type.
When to use
Reach for an admonition when a reader must not miss a piece of information in the normal flow of the page: a warning about data loss, a prerequisite, a tip, or a note that qualifies the surrounding text. Use :::info[Preview] to flag features in Preview.
Technical details
The following admonition directives are supported:
:::warning:::important:::tip:::note:::info:::prompt
Each directive can optionally specify a custom title in square brackets, for example :::info[Preview]. Close every admonition with a matching ::: line.
Rules
- Open and close each admonition with a
:::fence. - The title in square brackets is optional; when omitted, the admonition uses its default title.
- Use
:::info[Preview]for features in Preview.
Style
- Keep a callout to a single idea, and keep it short — an admonition is an interruption.
- Don't stack multiple admonitions back to back; if everything is highlighted, nothing is.
Template
:::warning
Your callout text.
:::
Examples
Example:
:::warning
This is a warning.
:::
:::important
This is an important notice.
:::
:::note
This is a note.
:::
:::tip
This is a tip.
:::
:::info[Preview]
This is an info notice with a custom title (suggested for features in Preview).
:::
:::prompt
Tell :re[Genie Code] (Agent mode) to do this for you:
```
This is an example prompt.
```
:::
Output:
This is a warning.
This is an important notice.
This is a tip.
This is a note.
This is an info notice with a custom title (suggested for features in Preview).
Tell Genie Code (Agent mode) to do this for you:
This is an example prompt.
Used in
Content atoms appear in any page section. Admonitions are especially common in Limitations, Requirements, and Procedure.