Callouts are special blocks that help highlight important information in your documentation. Here are some examples of how to use them:
::: info Title This is an info callout. Use it for general information or highlighting key points. :::
::: warning Important Warning This is a warning callout. Use it to alert users about potential issues or actions they should be cautious about. :::
::: error Critical Error This is an error callout. Use it for critical alerts, failures, or things that need immediate attention. :::
::: tip Pro Tip
This is a tip callout. Use it for helpful suggestions, best practices, or shortcuts. Need to display backticks inside a code block? See this section to learn how to escape them.
:::
::: note This is a note callout without a title. Use it for secondary information, side notes, or less critical details. :::
To use a callout in your markdown, use the following syntax:
::: type Optional Title
Your content goes here.
You can include **markdown** and
other content like lists:
- Item 1
- Item 2
:::
Available types:
info(default if type is omitted, but recommended to be explicit)warningerrortipnote
If the title is omitted, the callout will render without one (except for the tip style which might look better with one).