u-blox
Overview
ReStructuredText Examples
Thingstream
Get started

2. MyST

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:

Note

Markdown:

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

Rendered Output:

Note
Try changing note to warning!

Note with custom title

Markdown:

:::{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.

Warning

Markdown:

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

Rendered Output:

Warning
this is a warning message

Tip

Markdown:

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

Rendered Output:

Tip
this is a success message

Error

Markdown:

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

Rendered Output:

Error
this is a error message

Emphasis

~~Strikethrough~~

Rendered Output: Strikethrough