Callout
Highlight an important note, tip, warning, or error in an MDX page.
Loading documentation…
Powered by heyo
Callout separates important guidance from the normal reading flow. It is best
for a practical tip, a prerequisite, a warning, or an error condition that a
reader should notice while following an article.
Use note for neutral context, info for helpful facts, tip for a preferred
approach, and check for a successful outcome. Reserve warning and danger
for situations where ignoring the content has a meaningful consequence.
Preview the page locally so broken links and invalid MDX do not reach readers.
You can provide a short string with description, or use children when the
message needs Markdown, links, or another MDX component. Keep each callout to
one focused point.
Stack related callouts to turn a dry deployment status into a scannable update. Each treatment gives the reader a useful visual cue without obscuring the timeline.
Existing links continue to work while the new pages are generated.
Content changes made during the final sync will not be included.
The preview is live and the search index has been refreshed.
Selects the icon and accent colour. It defaults to note.
Compatibility alias for type. default maps to
note and destructive maps to danger.
An optional heading placed above the message.
The message body. It takes precedence over the component's children.
Alternative rich message content when description is not set.