Admonitions¶

Use Admonitions, also known as call-outs, to call attention to warnings, notes, and tips. Material for MkDocs provides 12 Admonitions Types and allows for the inclusion of any type of content.

To create an Admonition, start a line with !!! or ???, followed by a type and (optionally) a title. On the next line create the content of the block, indented by four spaces.

Note

Admonition with the type 'note' that is expanded.

!!! note
    Text in Admonition

Note

Admonition with the type 'note' that is expanded, but can be closed.

???+ note
     Text in Admonition

Note

Admonition with the type 'note' that is collapsed but can be expanded.

??? note
    Text in Admonition

Alternative title

Admonition with the type 'note' with an alternative title.

!!! note "Alternative Title"
    Text in Admonition

Admonition with the type 'note' without a title.

!!! note ""
    Text in Admonition

Code block

Admonition with the type 'note' with an any type of content e.g. a Code block.

Syntax

``` javascript
document.write("Hello World!");
```

Result

document.write("Hello World!");

Types¶

There are 12 types of Admonitions:

note

Note

??? note
    Text in Admonition

abstract, summary, tldr

Abstract

??? abstract
    Text in Admonition

info, todo

Info

??? info
    Text in Admonition

tip, hint, important

Tip

??? tip
    Text in Admonition

success, check, done

Success

??? success
    Text in Admonition

question, help, faq

Question

??? question
    Text in Admonition

warning, caution, attention

Warning

??? warning
    Text in Admonition

failure, fail, missing

Failure

??? failure
    Text in Admonition

danger, error

Danger

??? danger
    Text in Admonition

bug

Bug

??? bug
    Text in Admonition

example

Example

??? example
    Text in Admonition

quote, cite

Quote

??? quote
    Text in Admonition