Admonitions allow you to highlight important information with varying levels of priority. In software documentation, these blocks are used to emphasize risks, provide helpful advice, or share relevant but non-critical details.
Admonitions can span multiple lines and support inline formatting. Available admonition types include:
A relevant piece of information with no serious repercussions if ignored.
:::::{tab-set}
::::{tab-item} Output
:::{note} This is a note. It can span multiple lines and supports inline formatting. :::
::::
::::{tab-item} Markdown
:::{note}
This is a note.
It can span multiple lines and supports inline formatting.
:::::::
:::::
You could permanently lose data or leak sensitive information.
:::::{tab-set}
::::{tab-item} Output
:::{warning} This is a warning. :::
::::
::::{tab-item} Markdown
:::{warning}
This is a warning.
:::::::
:::::
Advice to help users make better choices when using a feature.
You could permanently lose data or leak sensitive information.
:::::{tab-set}
::::{tab-item} Output
:::{tip} This is a tip. :::
::::
::::{tab-item} Markdown
:::{tip}
This is a tip.
:::::::
:::::
Ignoring this information could impact performance or the stability of your system.
:::::{tab-set}
::::{tab-item} Output
:::{important} This is an important notice. :::
::::
::::{tab-item} Markdown
:::{important}
This is an important notice.
:::::::
:::::
A plain admonition is a callout with no further styling. Useful to create a callout that does not quite fit the mold of the stylized admonitions.
:::::{tab-set}
::::{tab-item} Output
:::{admonition} This is my callout It can span multiple lines and supports inline formatting. :::
::::
::::{tab-item} Markdown
:::{admonition} This is my callout
It can *span* multiple lines and supports inline formatting.
:::::::
:::::
:::{include} _snippets/applies-to-admonitions.md :::