Admonitions

Admonitions are callout blocks used to highlight information such as notes, warnings, tips, and errors. They help distinguish important content from the main flow of the document.

Basic admonitions

Use quote-block syntax together with an admonition marker such as [!note] or [!warning]:

> [!note]
> A note

Note

A note

> [!warning]
> A warning

Warning

A warning

Admonition titles

You can place a title after the admonition type:

> [!warning] With a title
> A warning

With a title

A warning

Foldable admonitions

Admonitions can be foldable. Use - for foldable but initially open, and + for folded:

> [!success]-
> Foldable, but unfolded

Success

Foldable, but unfolded

> [!danger]+ Folded with a title
> Foldable

Folded with a title

Foldable

Nested admonitions

Admonitions can be nested inside one another using nested quote syntax:

> [!tip] Nested admonitions
> > [!info]
> > > [!success]
> > > This is the first inner-inner admonition
> > 
> > > [!error]
> > > This is the second inner-inner admonition

Nested admonitions

Info

Success

This is the first inner-inner admonition

Error

This is the second inner-inner admonition