Callout #

Use callouts for important narrative notes and tips.

Props #

PropTypeRequiredDescription
iconstringNoIcon name resolved by Icon.
variant'default' | 'caution' | 'error' | 'note' | 'success'NoColor variant for the callout block.
childrenReactNodeYesCallout content.

Examples #

Live examples #

Keep docs task-oriented and skimmable.

This action can affect existing navigation and links.

Build failed because a referenced page path does not exist.

This is a note-style callout for context and reference details.

Configuration saved and applied successfully.

Push to main to publish to GitHub Pages.

Update sidebar.json whenever you add new guides.

Code #

Default icon #

mdx
<Callout>
Keep docs task-oriented and skimmable.
</Callout>

Caution variant #

mdx
<Callout variant="caution" icon="alert">
This action can affect existing navigation and links.
</Callout>

Error variant #

mdx
<Callout variant="error" icon="error">
Build failed because a referenced page path does not exist.
</Callout>

Note variant #

mdx
<Callout variant="note" icon="book">
This is a note-style callout for context and reference details.
</Callout>

Success variant #

mdx
<Callout variant="success" icon="check">
Configuration saved and applied successfully.
</Callout>

Rocket callout #

mdx
<Callout icon="rocket">
Push to main to publish to GitHub Pages.
</Callout>

Tooling callout #

mdx
<Callout icon="tool">
Update `sidebar.json` whenever you add new guides.
</Callout>