Callouts
Note, Warning, Tip, Info and Danger components for highlighting important content.
Callouts draw attention to important information. Use them sparingly to maintain impact.
Note
Use <Note> for important context that readers shouldn't miss:
API keys are scoped to a single project. Create separate keys for each environment.
Warning
Use <Warning> for potential issues, breaking changes, or dangerous operations:
This action cannot be undone. All associated data will be permanently deleted.
Tip
Use <Tip> for helpful suggestions and best practices:
Enable caching in production to reduce API calls by up to 90%.
Info
Use <Info> for supplementary information:
This feature is available on the Pro plan and above.
Danger
Use <Danger> for destructive or irreversible operations:
Deleting a project permanently removes all pages, builds, and analytics data.
Deprecated forms
Two other spellings render, but are deprecated
and will stop working at the end of their notice window. The build log warns
with the file and line; stx migrate rewrites both.
<Callout type="…"> used to render as an unstyled box; it now renders as the
named callout its type selects. An unknown type stays unstyled.
| Old form | Use instead |
|---|---|
<Caution> | <Warning> |
<Callout type="note"> … type="danger" | The named callout: <Note>, <Info>, <Tip>, <Warning> or <Danger> (type="caution" becomes <Warning>) |
Regenerating your webhook secret invalidates all in-flight deliveries.
With Titles
Add a custom title with the title prop:
The title renders as a heading on its own line above the body, in the callout's status colour. If you write your own bold first line instead, that is left as the heading and no second one is added.
The API is limited to 100 requests per minute per API key.
With Code
Callouts can contain code blocks and other markdown:
The userId parameter has been renamed to user_id:
Blockquote Shorthand
Plain Markdown blockquotes are auto-styled as callouts — useful for content migrated from other platforms. Two forms are recognized:
Bold label — the label picks the callout type, each with its own icon and palette:
| Label | Type | Icon |
|---|---|---|
| Note | Note | Pin (indigo) |
| Info, Information | Info | Circle-info (blue) |
| Tip, Hint | Tip | Lightbulb (emerald) |
| Warning, Caution | Warning | Triangle-alert (amber) |
| Danger, Error, Critical | Danger | Octagon-alert (red) |
| Security, Secure | Security | Shield (teal) |
| Success, Complete | Success | Circle-check (green) |
| Important, Remember, Attention | Important | Circle-alert (violet) |
ReadMe-style emoji prefix — 📘/📝/📌 → Note, ⚠️/🚧 → Warning, 💡 → Tip, 🚨/🛑/❌ → Danger, ℹ️ → Info, 🔒/🛡️ → Security, ✅/👍 → Success, ❗ → Important:
The emoji is replaced with the callout type's icon (an Untitled UI glyph, the same set as the rest of your doc site), and the first line becomes the callout title — emojis never render in your published docs.
On doc engine v2 only the exact bold labels Note, Info, Tip, Warning, Caution, Danger, Security, Success and Important make a callout. The synonyms (Information, Hint, Error, Critical, Secure, Complete, Remember, Attention) and the emoji prefixes are doc engine v1 only — on v2 they render as a plain quote.
Props
| Prop | Type | Default | Description |
|---|---|---|---|
title | string | (none) | Optional heading |
children | ReactNode | — | Content (required) |
When to Use
| Callout | Use For |
|---|---|
| Note | Important context, prerequisites, key information |
| Warning | Breaking changes, destructive actions, common pitfalls |
| Tip | Best practices, optimization suggestions, shortcuts |
| Info | Supplementary details, feature availability, links |
Best Practices
Limit callouts to 1-2 per section. Too many callouts create visual noise and reduce their impact.