Skip to content

Admonitions

In MkDocs Material, callouts are called Admonitions. You can implement them easily by following these steps:

Topics

Modify mkdocs.yml

To enable adminitions, ensure that your Material theme supports admonitions by adding these lines to your configuration file:

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences

Syntax for Callouts

Here's a basic example:

!!! note "Optional title"
    This is a simple note callout.

Types of Admonitions

You can use various predefined types:

Info

  • note
  • info
  • tip
  • warning
  • danger
  • success
  • question
  • example
  • quote
  • bug

Examples

!!! info "Important Information"
    Please read carefully before proceeding.

Important Information

Please read carefully before proceeding.

!!! warning "Be Careful!"
    You might lose your changes if you proceed without saving.

Be Careful!

You might lose your changes if you proceed without saving.

??? tip "Collapsible tip"
    This content is hidden until expanded by the user.
Collapsible tip

This content is hidden until expanded by the user.