GitHub-style alerts turn familiar blockquotes into visual callouts. Start a quote with an alert marker to call attention to useful context, a helpful tip, an important detail, a warning, or a caution.
Note
Use a note for useful context that helps readers understand what follows.
> [!NOTE]
> Alert markers are case-sensitive and go at the start of the first line inside the quote.NOTE
Alert markers are case-sensitive and go at the start of the first line inside the quote.
Tip
Use a tip to share an optional shortcut or a more convenient approach.
> [!TIP]
> Keep each alert focused on one idea so readers can scan it quickly.TIP
Keep each alert focused on one idea so readers can scan it quickly.
Important
Use an important alert for information readers should not miss.
> [!IMPORTANT]
> This blog supports all five GitHub-style alert types in Markdown posts.IMPORTANT
This blog supports all five GitHub-style alert types in Markdown posts.
Warning
Use a warning when an action may have an unexpected effect.
> [!WARNING]
> Changing a post's slug changes its public URL. Update any links that point to the old address.WARNING
Changing a post’s slug changes its public URL. Update any links that point to the old address.
Caution
Use a caution to call out a possible downside or consequence.
> [!CAUTION]
> Alerts emphasize a small amount of key information; they are not a replacement for clear headings and body text.CAUTION
Alerts emphasize a small amount of key information; they are not a replacement for clear headings and body text.
Comments could not be loaded. Please try again later.