Max Mustermann
Callout boxes are created from GitHub-style alerts in perfectly normal
Markdown: a blockquote whose first line contains [!type]. The blockquote
render hook turns it into a coloured box with icon and title.
The types #
> [!note]
> This is how you write a callout box.
A neutral note. note is the default type.
A piece of information - like note, just in blue.
A helpful tip (tip).
It worked! success is for completed things and successes.
Something important (important) that shouldn’t be missed.
A warning (warning) - caution is advised here.
caution - one level more serious.
Careful, something can break here - danger.
Something has failed (failure).
An open question or an FAQ entry - question.
Custom title #
Write the title after the type:
> [!tip] My custom title
> Content of the box.
The default title (“Tip”) is replaced by your text.
Collapsible #
A + turns the box into an expanded <details>, a - into a collapsed one:
> [!info]- Collapsed - tap to expand
> This content is hidden initially.
Collapsed - tap to expand
This content is hidden initially and expands on click.
Expanded - can be collapsed
This box is open but can be collapsed.
Aliases #
Many common spellings are translated automatically, e.g.
[!warning]/[!attention], [!tip]/[!hint], [!danger]/[!error],
[!success]/[!check]/[!done] or [!question]/[!faq].
hint is an alias for tip.
There is also an affiliate type for advertising disclosures - the theme also
shows it automatically at the top of posts containing affiliate links.
