Admonitions

Admonitions use GitHub’s alert syntax, so the same Markdown renders as callouts here and on GitHub and GitLab:

> [!NOTE]
> Useful background information.

The five types

Note

Background information the reader should notice in passing.

Tip

A best practice or shortcut.

Important

Must-read information for the task to succeed.

Warning

Something that can go wrong.

Caution

Destructive consequences ahead.

Custom titles

Add the title on the marker line:

> [!TIP] Name your versions consistently
> The label line replaces the default "Tip".

Name your versions consistently

The label line replaces the default “Tip”. Icon and colors stay.

Rich content inside

Any Markdown works inside the body: multiple paragraphs, lists, links and code blocks.

> [!WARNING]
> First paragraph with **bold** and `inline code`.
>
> ```bash
> echo "code blocks too"
> ```
>
> - and lists
> - work fine

Warning

First paragraph with bold and inline code.

bash

echo "code blocks too"

• and lists
• work fine

Plain blockquotes (no [!…] marker) keep their own separate quote styling:

A regular quote, unaffected by admonition styles.

Notes

• Default labels translate per language via data/i18n. See languages.
• All five types map to distinct icon and color combinations that follow the active theme.