Admonition

Callout boxes for notes, warnings, and tips

1 min read 147 words

Callout boxes for highlighting important information.

Basic Usage

:::{note}
This is a note.
:::{/note}

Types

Note

:::{note}
General information.
:::{/note}

Warning

:::{warning}
Potential issues to be aware of.
:::{/warning}

Tip

:::{tip}
Helpful suggestions.
:::{/tip}

Important

:::{important}
Critical information.
:::{/important}

Caution

:::{caution}
Proceed with care.
:::{/caution}

Danger

:::{danger}
Risk of data loss or security issues.
:::{/danger}

Custom Titles

:::{note} Custom Title
Content with a custom title.
:::{/note}

Options

Option Type Description
class string Additional CSS classes
name string Reference target name

Nesting

Admonitions can contain any Markdown:

:::{note}
This note contains:

- A list
- With items

```python
# And code
print("Hello")
```
:::{/note}