Alert Callout Reference

The platform recognizes GitHub-style alerts: a blockquote whose first line is an alert designator in the form > [!TYPE]. The rest of the blockquote is the alert body. Rendering is color-only — the border and background change to a SAP MessageStrip color, but there is no icon and no heading label, so write a body that reads on its own.

Each block below shows the exact markdown followed by how it renders. Read this step on the published page to see the colors.

Plain blockquote (no designator) → blue (Information)

A blockquote with no designator is the default. Use it for an ordinary aside that doesn’t need special emphasis.

> This is a plain blockquote. It renders in the default Information blue.

This is a plain blockquote. It renders in the default Information blue.

> [!NOTE] → blue (Information)

Use for supplementary information the reader should notice but that carries no risk. Renders the same blue as a plain blockquote, but makes your intent explicit in the source.

> [!NOTE]
> Highlights information that users should take into account, even when skimming.

Highlights information that users should take into account, even when skimming.

> [!TIP] → green (Success)

Use for helpful advice, shortcuts, or a better way to do something. The green reads as “this is a good idea,” not “danger.”

> [!TIP]
> Prefer the frontmatter `video:` field over an inline iframe — it gets the lightbox and responsive sizing for free.

Prefer the frontmatter video: field over an inline iframe — it gets the lightbox and responsive sizing for free.

> [!IMPORTANT] → purple (Emphasis)

Use for information that is crucial to the reader succeeding — a key prerequisite, a value they must note now and reuse later. The purple is distinct from NOTE’s blue so the two don’t blur together.

> [!IMPORTANT]
> Copy the service key's `clientid` now — you'll paste it into the destination configuration two steps from here.

Copy the service key’s clientid now — you’ll paste it into the destination configuration two steps from here.

> [!WARNING] → amber (Warning)

Use for something that could cause a problem if the reader isn’t careful — a destructive flag, an irreversible setting, a common foot-gun. Amber signals “slow down and read.”

> [!WARNING]
> Running `cds deploy --to hana` against a production binding will drop and recreate the schema. Confirm your target with `cf target` first.

Running cds deploy --to hana against a production binding will drop and recreate the schema. Confirm your target with cf target first.

> [!CAUTION] → red (Error)

Reserve for genuine danger — data loss, security exposure, or an action that cannot be undone. Red is the loudest callout; using it for a mere tip trains readers to ignore it.

> [!CAUTION]
> This command deletes every row in the `Progress` table and cannot be undone. There is no soft-delete and no backup unless you took one.

This command deletes every row in the Progress table and cannot be undone. There is no soft-delete and no backup unless you took one.

Styled plain blockquote (lead-in bold)

If you want an emphasized aside without a semantic color — just a labeled note — a plain blockquote with a bold lead-in works and stays Information blue. This is the pattern used by the maintenance note at the top of this tutorial.

> **Heads up:** a bold lead-in gives you a labeled aside without reaching for an alert color.

Heads up: a bold lead-in gives you a labeled aside without reaching for an alert color.

Two things to remember:

• Pick by intent, not loudness. An ordinary note can stay a plain > or [!NOTE] (blue). Save [!WARNING]/[!CAUTION] for real risk — if everything is a caution, nothing is.
• The designator must be the first line, on its own, inside the blockquote. An unknown designator (anything other than the five above) silently falls through and renders as a plain blue blockquote.