Admonitions

Pipeline A does not support admonitions. Writing > [!NOTE] inside an AUP text primitive with format: "markdown" renders as a plain blockquote with the literal text [!NOTE] on the first line — marked has no concept of this syntax. Everything on this page requires pipeline B (a content.md file).

The syntax is GitHub's alert blockquote: a > [!TYPE] marker as the literal first line of a blockquote, one of five recognized (case-insensitive) types.

The five types

Source:

> [!NOTE]
> Useful context that doesn't change the outcome.

> [!TIP]
> A suggestion that makes the reader's life easier.

> [!IMPORTANT]
> Something the reader needs to know to succeed.

> [!WARNING]
> Something that could cause a problem if ignored.

> [!CAUTION]
> Risk of data loss or a breaking change.

Rendered:

Each one carries its own data-intent and a distinct icon; the default label (Note/Tip/Important/Warning/Caution) is hardcoded English unless the site's locale has an entry in ADMONITION_LOCALIZED_LABELS (currently only zh).

Custom title

The default label can be overridden with same-line text right after the marker.

Source:

> [!TIP] Faster iteration
> Run the dev server with `--watch` instead of restarting it by hand.

Rendered:

If there's no text on the marker's own line, the default label is used — that's every example above.

Block content inside an admonition

Every blockquote child — not just the first paragraph — converts through the same markdown pipeline, so lists, code blocks, and further paragraphs nested inside an admonition are preserved as real children instead of being flattened into a single string.

Source:

> [!IMPORTANT] Before you deploy
>
> - Run the test suite
> - Check the migration script
>
> ```bash
> arc space diff --server https://staging.example.com
> ```

Rendered:

arc space diff --server https://staging.example.com

Unrecognized markers degrade to a plain quote

A marker outside the five recognized types (or a typo) is left as-is — the whole blockquote falls back to a plain, unstyled quote rather than crashing or silently disappearing.

Source:

> [!DANGER]
> Not a real type — GitHub itself doesn't recognize this one either.

Rendered:

[!DANGER] Not a real type — GitHub itself doesn't recognize this one either.

Locale defaults (documented, not live on this site)

When the reading locale has an entry in ADMONITION_LOCALIZED_LABELS (content-reader.ts), a bare marker with no custom title gets that locale's label instead of the English default — e.g. a zh reader sees 提示 instead of Tip for a bare [!TIP]. This showcase site runs a single en locale, so that behavior isn't shown as a live example on this page; an author-supplied title (as in the "Custom title" example above) always wins regardless of locale.