Admonitions

Admonitions are a great way to highlight important information in your documentation. Make sure to check Colors for the color scheme used in admonitions in both light and dark mode.

Note

This is how an admonition with multiple paragraphs looks like.

It can include many words.

There is also some text between admonitions.

Warning

• How is the padding in this list?

• Is it consistent?

• Does it look good with other elements?

Attention

Keep track of spacing and margins in admonitions.

• This is how they look like;

• Rely on upstream as much as possible.

And this is how an admonition with a title looks like:

You can use titles!

Sometimes they are helpful.

All admonitions

The following admonition types are supported.

Attention

This is an attention admonition.

Caution

This is a caution admonition.

Warning

This is a warning admonition.

Danger

This is a danger admonition.

Error

This is an error admonition.

Hint

This is a hint admonition.

Tip

This is a tip admonition.

Important

This is an important admonition.

Note

This is a note admonition.