Skip to content
Writing Documentation

Callouts

Notes, tips, and warnings that fit the documentation.

Write a Callout

Start a blockquote with [!TYPE]. Add an optional title on the same line and write the body on the following quoted lines:

md
> [!TIP] A useful shortcut
> Use **Markdown**, inline code, links, and lists in the body.

No import or plugin is required. Choose one of the five uppercase markers:

Try the variants

md
> [!NOTE] A useful note
> Explain a detail without interrupting the main instructions.
md
> [!TIP] Keep it short
> Use a Callout when the context changes how the reader should proceed.
md
> [!SUCCESS] Ready to continue
> Your documentation is ready for the next step.
md
> [!WARNING] Before updating
> Read the release notes and validate your production build.
md
> [!DANGER] Review destructive changes
> Confirm the exact files before deleting source content.

Optional titles and rich content

Leave the title out for a compact note. Continue the quote with a blank quoted line before a list or another paragraph:

md
> [!NOTE]
> Before continuing:
>
> - Review your configuration.
> - Run a production build.