Components

Callouts

Highlight important information with callout boxes.

Types of callouts

Callouts draw attention to important information. Use them sparingly to maintain their impact.

note

This is a note callout. Use it for supplementary information that adds context to the main content.

tip

This is a tip callout. Use it for helpful suggestions and best practices that improve the user experience.

info

This is an info callout. Use it for general information that the reader should be aware of.

warning

This is a warning callout. Use it for potential issues or important caveats that could cause problems.

danger

This is a danger callout. Use it for critical warnings about actions that could cause data loss or security issues.

Callouts can contain any markdown content:

Pro tip

You can include bold text, inline code, and even links like this one inside callouts.

You can also include multiple paragraphs and lists:

Important

Make sure to back up your data before running:

example-cli migrate --force

This action cannot be undone.

Your custom title here

Callouts support custom titles to better describe their content.

Did you know?

You can customize the title of any callout type to make it more descriptive and contextual.