Skip to content

Latest commit

 

History

History
294 lines (242 loc) · 3.52 KB

File metadata and controls

294 lines (242 loc) · 3.52 KB

Simple admonition . !!! note content .

Note

content

.

Could contain block elements too . !!! note ### heading

-----------

.

Note

heading


.

Shows custom title . !!! note Custom title

Some text

.

Custom title

Some text

.

Shows no title . !!! note "" Some text

.

Some text

.

Closes block after 2 empty lines . !!! note Some text

A code block

.

Note

Some text

A code block
.

Nested blocks . !!! note !!! note Some text

        code block

.

Note

Note

Some text

code block
.

Consecutive admonitions . !!! note

!!! warning .

Note

Warning

.

Marker may be indented up to 3 chars . !!! note content .

Note

content

.

But that's a code block . !!! note content .

!!! note
    content

.

Some more indent checks . !!! note not a code block

code block

.

Note

not a code block

code block
.

Type could be adjacent to marker . !!!note xxx

.

Note

xxx

.

Type could be adjacent to marker and content may be shifted up to 3 chars . !!!note xxx

.

Note

xxx

.

Or several spaces apart . !!! note xxx .

Note

xxx

.

Admonitions self-close at the end of the document . !!! note xxx .

Note

xxx

.

They could be nested in lists .

  • !!! note - a - b
  • !!! warning - c - d .
  • Note

    • a
    • b
  • Warning

    • c
    • d
.

Or in blockquotes .

!!! note xxx > yyy zzz

.

Note

xxx

yyy zzz

.

Renders unknown admonition type . !!! unknown title content .

title

content

.

Does not render . !!! content .

!!! content

.

MKdocs Closed Collapsible Sections . ??? note content .

Note

content

.

MKdocs Open Collapsible Sections . ???+ note content .

Note

content

.