Admonitions
Admonitions (also called callouts or aside boxes) highlight important information with colored boxes and icons.
Syntax
!!! type "Optional title"
Content goes here. Must be indented.
Types
Note
!!! note
This is a note admonition.
Note
This is a note admonition.
Tip
!!! tip
This is a tip admonition.
Tip
This is a tip admonition.
Warning
!!! warning
This is a warning admonition.
Warning
This is a warning admonition.
Danger
!!! danger
This is a danger admonition.
Danger
This is a danger admonition.
Info
!!! info
This is an info admonition.
Info
This is an info admonition.
Success
!!! success
This is a success admonition.
Success
This is a success admonition.
Abstract
!!! abstract
This is an abstract admonition.
Abstract
This is an abstract admonition.
Collapsible admonitions
Add ? to make the admonition collapsible:
??? note "Click to expand"
This content is hidden by default.
Click to expand
This content is hidden by default.
Add + to make it expanded by default:
???+ note "Already expanded"
This content is visible by default.
Already expanded
This content is visible by default.
Custom titles
!!! note "Custom title here"
You can replace the default type label.
Custom title here
You can replace the default type label.
Without icon
!!! note ""
No icon, just the title and content.
No icon, just the title and content.
Nested content
Admonitions can contain any Markdown, including code blocks:
!!! example "Configuration example"
``` yaml
theme:
palette:
primary: teal
```
Configuration example
theme:
palette:
primary: teal
All admonition types
| Type | Color | Icon | Use for |
|---|---|---|---|
note | Blue | Info circle | General information |
abstract | Cyan | Document | Summaries, abstracts |
info | Blue | Info | Detailed information |
tip | Green | Lightbulb | Helpful advice |
success | Green | Check | Positive outcomes |
question | Orange | Help circle | Questions, FAQs |
warning | Orange | Alert triangle | Caution needed |
failure | Red | X circle | Something failed |
danger | Red | Flash | Critical warnings |
bug | Red | Bug | Bug reports |
example | Purple | List | Examples |
quote | Grey | Quote | Quotations |