Alerts
GFM alerts are a special form of blockquote with a type marker. They render as styled callout boxes in the preview.
Standard alert types
> [!NOTE]
> Useful information that users should know, even when skimming content.
> [!TIP]
> Helpful advice for doing things better or more easily.
> [!IMPORTANT]
> Key information users need to know to achieve their goal.
> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.
> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.
Custom titles
Use parentheses or text after the marker:
> [!NOTE](Custom title)
> Alerts can use a custom title in parentheses.
> [!TIP] Custom title after marker
> Alerts can also use a custom title after the marker.
Supported types
| Type | Default title |
|---|---|
NOTE | Note |
TIP | Tip |
IMPORTANT | Important |
WARNING | Warning |
CAUTION | Caution |
Type markers are case-insensitive in the parser ([!note] and [!NOTE] are equivalent).
Writing alerts
Alerts are written as blockquotes. Type the marker on the first line after >:
> [!WARNING]
> Double-check your configuration before deploying.
There is no dedicated toolbar button for alerts; use the blockquote command and type the alert marker manually, or paste the syntax from the examples above.