Admonitions¶

Void styles the standard MkDocs admonition extension, plus collapsible ??? (details) blocks and inline variants. Every type maps to a themed accent color and a small icon in the title.

Usage¶

!!! note
    A note uses the accent blue color.

Types¶

Note / Info / Example¶

!!! note
    A generic note.

!!! info
    Additional information.

!!! example
    An example block.

Abstract / Summary / TLDR¶

!!! abstract "Summary"
    A condensed takeaway.

Tip / Hint / Question / FAQ¶

!!! tip
    A helpful tip.

!!! question
    A question worth asking.

Success / Done / Check¶

!!! success
    Everything worked.

Warning / Caution / Attention¶

!!! warning
    Watch out.

Danger / Error / Failure / Bug / Important¶

!!! danger
    This is destructive.

!!! bug
    Known defect.

!!! important
    Really important requirement.

Quote¶

!!! quote
    "Less, but better." — Dieter Rams

Collapsible (details)¶

Use ??? for an initially-closed block and ???+ for an open-by-default block.

??? note "Expand me"
    Hidden until expanded.

???+ danger
    Open by default and collapsible.

Inline¶

The inline class floats an admonition beside content.

!!! note inline
    Floats to the left in this layout.

Paragraph text that wraps around the inline admonition demonstrates the floating behavior. Copy continues to flow around the floated box, letting you place short callouts against prose without breaking the reading flow.

Custom types¶

Any unknown type still renders as a default-styled admonition. You can add your own by defining a color for the class in your CSS:

.admonition.mytype::before {
    background: #7a5cff;
}
.admonition.mytype .admonition-title {
    color: #7a5cff;
}