This page shows the available admonitions for this theme.
Tips are positive admonitions. A tip can be a shortcut for an action that was further explained in the main text, or a confirmation.
hint admonition is considered equivalent and appears in the same style.
Notes are neutral admonitions, that can draw the attention of the reader, but usually don’t have a positive or negative effect.
If you want to include a list of references to further documentation, you can use the
Use a general admonition for notes with custom titles.
caution admonition to make the user aware of important issues, or
important admonition is considered equivalent and appears in the same style.
warning is a negative admonition. Typically, anything involving security should
be emphasized with a warning. Ignoring the information in a warning usually has
error admonitions are considered equivalent and appear in the
Block quotations aren’t admonitions, but are used to quote other material and as such are often set apart from the main text.
“It is my business to know things. That is my trade.”