Admonitions¶

Admonitions allow you to highlight important information, tips, warnings, and other notable content in your documentation.

Syntax¶

Admonitions in MyST Markdown are created using the ::: syntax followed by the admonition type. The general format is:

:::{admonition-type}
Your content here
:::

:::{important}
This is an important piece of information that readers should pay close attention to.
:::

Renders:

Important

This is an important piece of information that readers should pay close attention to.

:::{note}
This is a note providing additional context or helpful information.
:::

Renders:

Note

This is a note providing additional context or helpful information.

:::{tip}
Here's a helpful suggestion or best practice.
:::

Renders:

Tip

Here’s a helpful suggestion or best practice.

:::{warning}
This is a warning about potential issues or risks that readers should be aware of.
:::

Renders:

Warning

This is a warning about potential issues or risks that readers should be aware of.

:::{caution}
This admonition highlights potential pitfalls.
:::

Renders:

Caution

This admonition highlights potential pitfalls.

:::{error}
This indicates a critical error or something that must be avoided.
:::

Renders:

Error

This indicates a critical error or something that must be avoided.