Admonition
- 1 Syntax
- 2 Examples
- 2.1 Notes
- 2.2 Note
- 2.3 Info
- 2.4 Some title
- 2.5 Warning
- 2.6 WARNING
- 2.7 Danger
- 2.8 Danger with <code><code></code>
- 2.9 Notes without titles
- 3 Confluence
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.
Danger
Notes without titles
Confluence
Confluence upload will convert admonition into confluence macros.
note
becomes an Info macroinfo
becomes an Info macrowarning
becomes a Note macrodanger
becomes a Warning macro
Everything that isn’t recognized will be rendered as Info