Components

Callout

Highlight important information

Callouts highlight important information in your documentation.

Types

This is an informational callout. Use it for general information and tips.

<Callout type="info">
  This is an informational callout.
</Callout>

This is a warning callout. Use it for important notices.

<Callout type="warning">
  This is a warning callout.
</Callout>

This is a tip callout. Use it for helpful tips and best practices.

<Callout type="tip">
  This is a tip callout.
</Callout>

This is a danger callout. Use it for critical warnings.

<Callout type="danger">
  This is a danger callout.
</Callout>

You can provide a custom title for any callout type.

<Callout type="info" title="Custom Title">
  Content with custom title.
</Callout>

type'info' | 'warning' | 'tip' | 'danger' | 'note'default: 'info'

Callout type which determines the icon and color scheme

titlestring

Custom title (defaults to the type name)