Callout Syntax (MD)

This guide shows how to use GitHub-style alert syntax in Markdown (.md) files.

Note: For MDX files, see Callout Components (MDX) which uses Astro components.

Use blockquotes with special syntax to create alerts.

NOTE

This is a note alert. It’s perfect for supplementary information that readers might find helpful.

TIP

This is a tip alert. It’s great for sharing shortcuts or recommendations.

IMPORTANT

This is an important alert. Use it when readers need to pay special attention.

WARNING

This is a warning alert. Use it when readers need to be careful about something.

CAUTION

This is a caution alert. Use it to advise about risks or negative outcomes.

Alerts can contain multiple paragraphs and other markdown content.

NOTE

This is the first paragraph of the note. It provides some initial context or information.

This is the second paragraph. Alerts can contain multiple paragraphs to provide more detailed explanations.

You can also include bold, italic, and code formatting.

Alerts support lists and other markdown features.

TIP

Here are some best practices:

Or use unordered lists:

Use this syntax in any Markdown file:

> [!NOTE]
> Your content here.

Type	Use Case
`NOTE`	General information, side notes
`TIP`	Suggestions, best practices
`IMPORTANT`	Critical information
`WARNING`	Potential issues, important considerations
`CAUTION`	Risks, negative outcomes