Admonitions
Admonitions are boxed callouts for text that stands apart from the main flow.
The kinds match GitHub's alert vocabulary, plus a neutral callout.
Kinds
:::note
Body of the note.
:::Note
Note. Supplementary information a reader can skip without losing the thread.
Tip
A better way to do something.
Important
Information the reader needs to succeed.
Warning
Warning
Something that needs attention before proceeding.
Caution
Caution
An action with negative consequences.
Callout
A neutral box for anything that just needs visual separation.
Behavior
- The title ("Note", "Tip", ...) is generated and translated to the publication's language – a Russian publication renders Заметка, a German one Hinweis. You cannot set a custom title; if you need one, a collapsible section or a bold lead-in sentence may fit better.
- The body is full Markdown: lists, math, code, links.
- Admonitions are for editorial voice – notes to the reader. For mathematical structure (definitions, remarks as results), use statements; for quoting a source, use a blockquote.
Used sparingly, admonitions guide attention. A page that is half callouts has no callouts.