callout

16 cases. Source: tests/callout.json.

#1 canonical

Source

> [!WARNING] Breaking change in v3
> The `render()` signature changed.

Rendered

Breaking change in v3

The render() signature changed.

Downgrade

> **Warning:** Breaking change in v3
>
> The `render()` signature changed.

#2 collapsed by default, no title

Source

> [!NOTE]-
> Collapsed by default.

Rendered

Note

Collapsed by default.

Downgrade

> **Note:**
>
> Collapsed by default.

#3 expanded with a title

Source

> [!TIP]+ Handy
> Body.

Rendered

Handy

Body.

Downgrade

> **Tip:** Handy
>
> Body.

#4 type is case-insensitive and normalized to uppercase

Source

> [!note] Heads up

Rendered

Heads up

Downgrade

> **Note:** Heads up

#5 marker alone

Source

> [!IMPORTANT]

Rendered

Important

Downgrade

> **Important:**

#6 title with inline markup

Source

> [!CAUTION] Use *care* here

Rendered

Use care here

Downgrade

> **Caution:** Use *care* here

#7 body with several blocks

Source

> [!NOTE] T
> one
>
> - a
> - b

Rendered

T

one

  • a
  • b

Downgrade

> **Note:** T
>
> one
>
> - a
> - b

#8 body starting on the next line without a title

Source

> [!TIP]
> First line
> second line

Rendered

Tip

First line second line

Downgrade

> **Tip:**
>
> First line
> second line

#9 nested: callout containing a card

Source

> [!NOTE] T
> :::card
> x
> :::

Rendered

T

x

Downgrade

> **Note:** T
>
> x

#10 nested: callout inside a card

Source

:::card
> [!TIP] t
> b
:::

Rendered

t

b

Downgrade

> **Tip:** t
>
> b

#11 lazy continuation line joins the body

Source

> [!NOTE] T
lazy

Rendered

T

lazy

Downgrade

> **Note:** T
>
> lazy

#12 plain blockquote is unchanged

Source

> quote

Rendered

quote

Downgrade

> quote

#13 marker not at the start is text

Source

> Note [!NOTE] x

Rendered

Note [!NOTE] x

Downgrade

> Note \[!NOTE] x

#14 marker glued to text is not a marker

Source

> [!NOTE]Title

Rendered

[!NOTE]Title

Downgrade

> \[!NOTE]Title

#15 marker outside a blockquote is text

Source

[!NOTE] x

Rendered

[!NOTE] x

Downgrade

\[!NOTE] x

#16 unknown type stays a blockquote

invalid

Source

> [!FOO] x

Rendered

[!FOO] x

Downgrade

> \[!FOO] x

Diagnostics: CALLOUT_UNKNOWN_TYPE