Admonition
The admonition shortcode creates visually distinct callout boxes to highlight important information in your content. It supports five different types, each with its own styling and icon.
Usage
| |
Parameters
| Parameter | Required | Default | Description |
|---|---|---|---|
| type | No | "note" | The admonition type: note, tip, info, warning, or danger |
| title | No | Capitalized type name | Custom title for the admonition box |
Available Types
Note (đĄ)
Use for general information or helpful notes.
| |
Colors: Blue border (#2196f3), light blue background (#e3f2fd)
Tip (â )
Use for helpful tips or best practices.
| |
Colors: Green border (#4caf50), light green background (#e8f5e9)
Info (âšī¸)
Use for informational content.
| |
Colors: Cyan border (#00acc1), light cyan background (#e0f7fa)
Warning (â ī¸)
Use for warnings or cautionary information.
| |
Colors: Orange border (#ff9800), light orange background (#fff3e0)
Danger (â)
Use for critical warnings or errors.
| |
Colors: Red border (#f44336), light red background (#ffebee)
Examples
Basic Note
Custom Title
With go Content
You can use bold, italic, and even code inside admonitions.
- Bullet points work too
- Multiple paragraphs are supported