Callouts
Use callouts to highlight notes, tips, warnings, and danger in your docs
Callouts draw attention to important information. The theme provides five types that match common documentation patterns.
Supported types
| Type | Use for |
|---|---|
info | General information, neutral notes |
note | Supplementary or reference information (gray) |
tip | Helpful tips, best practices |
warning | Important notices, caveats |
danger | Critical warnings, breaking changes |
Examples
Info
Info — Use for general information that isn’t a tip or warning.
Note
Note — Use for extra context or references (e.g. “See also …”).
Tip
Tip — Use for shortcuts, recommendations, or “pro” advice.
Warning
Warning — Use for deprecations, limitations, or things that can go wrong.
Danger
Danger — Use for security, data loss, or breaking changes.
In MDX
Import from @barodoc/theme-docs (full custom) or use the component name your setup exposes:
import { Callout } from "@barodoc/theme-docs";
<Callout type="tip" title="Quick tip">
Prefer `base` and `site` in config when deploying to a subpath.
</Callout>- type —
info|note|warning|tip|danger(default:info). - title — Optional; overrides the default label (e.g. “Info”, “Warning”).
For more examples and API details, see Callout.