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:

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

Rendered Output:

Note

Try changing note to warning!

2. Note with custom title

Markdown:

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

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

Rendered Output:

My custom title with Markdown!

This is a custom title for a note admonition.

3. Warning

Markdown:

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

Rendered Output:

Warning

this is a warning message

4. Tip

Markdown:

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

Rendered Output:

Tip

this is a success message

5. Error

Markdown:

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

Rendered Output:

Error

this is a error message

5. Last Update

Markdown:

Default  
:::{lastUpdate}
25-01-2025
:::

Rendered Output:

Last updated: Feb 3, 2025
Need help?Contact Support
Questions?Contact us