Admonitions

The Admonitions component enables you to add styled admonitions.

1. Select Admonition from the Embed list.
2. Edit the component and select a Type (Note, Tip, Info, Caution or Warning).
3. Give it a Title.
4. Enter the Content.

Examples:

Note

Use note admonitions for supplementary information.

Tip

Use tip admonitions to provide advice that it's safe to ignore.

Info

Use info admonitions for information that's sufficiently important that it needs to stand apart from the rest of the text.

Caution

Use caution admonitions when something may prevent an intended action from being completed.

Warning

Use warning admonitions when there is a risk of injury, security breach or data loss.

Related topics

• Comments – Add invisible comments to Markdown files.
• Context-sensitive help – Using anchor tags to provide conditional sensitive help.
• Markdown links – Links to other pages in Markdown.
• Head metadata – Declaring page-specific head metadata through MDX.
• Code blocks and snippets – Handling code blocks in docStatic.
• Figures – Images with captions and lightbox zoom.
• Footnotes – Automatically numbered and back-linked footnotes.