u-blox

Admonitions

Admonitions (also known as callouts) highlight a particular block of text, that exists slightly apart from the narrative of your page, such as a note or a warning. See full docs at Myst

The following core admonition types are available:

1. Note

Markdown:

:::{note}
Try changing `note` to `warning`!
:::

Rendered Output:

:::{note} Try changing note to warning! :::

2. Note with custom title

Markdown:

:::{admonition} My custom title with *Markdown*!
:class: note

This is a custom title for a note admonition.
:::

Rendered Output: :::{admonition} My custom title with Markdown! :class: note

This is a custom title for a note admonition. :::

3. Warning

Markdown:

:::{warning}
this is a warning message
:::

Rendered Output: :::{warning} this is a warning message :::

4. Tip

Markdown:

:::{tip}
this is a success message
:::

Rendered Output: :::{tip} this is a success message :::

5. Error

Markdown:

:::{error}
this is a error message
:::

Rendered Output: :::{error} this is a error message :::