Callouts
Highlight notes, tips, warnings, and danger inline.
Callouts
Use callouts to draw attention to information that breaks the flow of normal prose. Available variants: note, tip, warning, danger.
Note: Standard markdown blockquotes work fine, and look like this.
If your renderer supports a <Callout> component, prefer it for variants:
<Callout type="warning">
Don't enable this in production until you've tested in staging.
</Callout>When to use which
- Note — supplementary detail; the page works without it.
- Tip — a faster or better way to do the thing the user just read.
- Warning — a sharp edge that's easy to fall off of.
- Danger — irreversible or expensive consequences.