← Back to docs

syntax

Callouts Reference

All available callout types and how to use them

draft: true

Callouts Reference

Callouts are styled blocks for highlighting information.

Syntax

> [!type] Optional Title
> Content goes here

Available Types

TypeUse Case
noteGeneral information
tipHelpful suggestions
infoAdditional context
warningCaution needed
dangerCritical warnings
successPositive outcomes
questionPose a question
quoteQuotations
exampleShow examples
abstractSummaries
todoTask lists
bugKnown issues

Examples

Note

> [!note]
> This is a note.

Warning with Title

> [!warning] Be Careful
> This action cannot be undone.

Styling

Callouts are automatically styled based on their type with appropriate colors and icons.