Admonitions

To create an admonition, simply use a special syntax that starts with !!! followed by the type of admonition you want, such as note, warning, info, etc., and the title of the admonition.

For example, to create a note admonition, use !!! note Your Note Title and then add your note content.

!!! info Admonition title
Admonition content
!!!

Admonition title

Admonition content

The different admonition types are: abstract, attention, bug, caution, danger, error, example, failure, hint, info, note, question, quote, success, tip, warning.

Examples

Grey

demo for note

content for note

demo for quote

content for quote

Blue

demo for abstract

content for abstract

demo for info

content for info

demo for question

content for question

Green

demo for hint

content for hint

demo for success

content for success

demo for tip

content for tip

Orange

demo for bug

content for bug

demo for caution

content for caution

demo for warning

content for warning

Red

demo for attention

content for attention

demo for danger

content for danger

demo for error

content for error

demo for failure

content for failure

Others

demo for example

content for example