Table of Contents
Syntax
Admonitions are created using the following syntax:
!!! type "optional explicit title within double quotes"
Any number of other indented markdown elements.
This is the second paragraph.
Valid values for type
are: note
, info
, warning
, and danger
.
Any value other than these will be treated as note
Examples
Notes
Note
A note
will render with a neutral color.
- Sugar
- Eggs
- Flour
!!! note "Note"
A `note` will render with a neutral color.
* Sugar
* Eggs
* Flour
Info
Some title
info
renders like this.
!!! info "Some title"
`info` renders like this.
Warning
WARNING
warning
will warn you.
With a blockquote
!!! warning "WARNING"
`warning` will warn you.
> With a blockquote
Danger
Danger with <code>
danger
is Dangerous
!!! danger "Danger with `<code>`"
`danger` is Dangerous
Notes without titles
This note has no title !
!!! note
This note has no title !
Confluence
Confluence upload will convert admonition into confluence macros.
-
note
becomes an Info macro -
info
becomes an Info macro -
warning
becomes a Note macro -
danger
becomes a Warning macro
Everything that isn’t recognized will be rendered as Info