Custom alert blocks in markdown

How to get there: Open any post, comment, or KB article that uses markdown. Wrap your callout text between ::type and :: on their own lines.

Alert blocks render colored callout boxes inside your markdown content. They are useful for deprecation notices, warnings, tips, and any text you want readers to notice before they skim past it.

Syntax

Basic block:

::warning
This feature is being deprecated in the next release.
::

With an optional title in parentheses:

::info(Heads up)
Webhooks now retry up to three times on failure.
::

The opening ::type and the closing :: must each be on their own line. The content between them is parsed as markdown, so you can use bold, italics, links, and lists inside an alert.

The four types

  • ::warning, yellow box, for cautions and things that might trip the reader up.
  • ::info, blue box, for neutral notes, tips, and context.
  • ::danger, red box, for breaking changes, destructive actions, and hard warnings.
  • ::success, green box, for confirmations, recommendations, and "do this" guidance.

With a title

Add (Title text) right after the type to give the alert a bold header followed by a horizontal rule. Without a title, the alert renders as a plain colored block.

::danger(Breaking change)
The legacy API endpoint will be removed on January 1.
::

Use cases

  • Deprecation notices at the top of KB articles.
  • "Heads up" callouts for non-obvious behavior in feature docs.
  • Highlighting destructive actions in admin guides.
  • Marking recommended defaults or best practices.

Notes

  • The opening line is the literal characters :: followed immediately by the type name (warning, info, danger, or success). Any other word is ignored and the block renders as plain text.
  • The closing :: must sit on its own line.
  • Content inside an alert is processed as markdown, so links and basic formatting work as expected.