Tip

Admonitions can also be used before the first headline.

5 Admonitions#

5.1 Specific Admonitions#

https://docutils.sourceforge.io/docs/ref/rst/directives.html#specific-admonitions

In many themes only note and warning are supported!

Attention

Attention text and inline code.

Caution

Caution text and inline code.

Danger

Danger text and inline code.

Error

Error text and inline code.

Hint

Hint text and inline code.

Important

Important text and inline code.

Note

Note text and inline code.

Tip

Tip text and inline code.

Warning

Warning text and inline code.

5.2 Generic Admonitions#

https://docutils.sourceforge.io/docs/ref/rst/directives.html#generic-admonition

5.3 Topic#

https://docutils.sourceforge.io/docs/ref/rst/directives.html#topic

Topic title with a link and code

Topic text and inline code.

5.6 Nesting#

Note

Warning

This is a warning.

Note

Inner note text.

This is the warning again.

Topic

Note

Topic within admonition is not allowed! Topic within topic neither!

Topic

Warning

Deep nesting ahead:

See also

Note

Note

You shouldn’t use such deep nesting.

Warning

Warning

Really!

Topic

See also

Text.

See also

Note

Note text.

Note

Admonition in a block quote.

5.7 Overflow#

A long long long long long long long long long long long long long long long long long long long long long long long long long long long admonition title

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

A long long long long long long long long long long long long long long long long long long long long long long long long long long long topic title

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x

x