Skip to content

Admonition Extension

Vladimir Schneider edited this page Mar 12, 2018 · 1 revision

To create block-styled side content. For complete documentation please see the Admonition Extension, Material for MkDocs documentation. (Personal opinion: Material for MkDocs is eye-candy. If you have not taken a look at it, you are missing out on a visual treat.)

Block-Styled Side Content

!!! qualifier "Optional Title"
    block content 

No-Heading Content

!!! qualifier ""
    block content 

Collapsible Block-Styled Side Content:

Collapsed by default
??? qualifier "Optional Title"
    block content 
Open by default
???+ qualifier "Optional Title"
     block content 

Qualifiers are used to select the icon and the color of the block.

  • abstract style
    • abstract
    • summary
    • tldr
  • bug style
    • bug
  • danger style
    • danger
    • error
  • example style
    • example
    • snippet
  • fail style
    • failure
    • fail
    • missing
  • faq style
    • question
    • help
    • faq
  • info style
    • info
    • todo
  • note style
    • note
    • seealso
  • quote style
    • quote
    • cite
  • success style
    • success
    • check
    • done
  • tip style
    • tip
    • hint
    • important
  • warning style
    • warning
    • caution
    • attention

AdmonitionExample.png