Callouts are special blocks that help highlight important information in your documentation. Here are some examples of how to use them:
:::info[Title]{.callout} This is an info callout. Use it for general information or highlighting key points. :::
:::warning[Important Warning]{.callout} This is a warning callout. Use it to alert users about potential issues or actions they should be cautious about. :::
:::error[Critical Error]{.callout} This is an error callout. Use it for critical alerts, failures, or things that need immediate attention. :::
:::tip[Pro Tip]{.callout} 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{.callout} 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]{.callout}
Your content goes here.
You can include **markdown** and
other content like lists:
- Item 1
- Item 2
:::
Available directive names (type):
infowarningerrortipnote
Include the title in square brackets [] after the type. Add the class .callout in curly braces {}. The specific type class (.callout-info, etc.) will be added automatically.