Admonitions & content tabs

Admonitions (call-outs) and content tabs are two of the most-used Material features. This page shows every variant rendered live next to its Markdown, so you can copy the exact syntax you need. Both are always available — admonitions and tabs work out of the box.

Admonition types

Write an admonition with !!!, a type keyword, and an optional "Title". The type sets the color and icon. Each type below is rendered as it will appear on your site.

Note

!!! note — general information the reader should notice.

Abstract

!!! abstract (aliases: summary, tldr) — a short summary.

Info

!!! info (alias: todo) — supplementary information.

Tip

!!! tip (aliases: hint, important) — a helpful suggestion.

Success

!!! success (aliases: check, done) — something that worked.

Question

!!! question (aliases: help, faq) — an open question or FAQ entry.

Warning

!!! warning (aliases: caution, attention) — proceed carefully.

Failure

!!! failure (aliases: fail, missing) — something that did not work.

Danger

!!! danger (alias: error) — a critical or dangerous note.

Bug

!!! bug — a known bug or defect.

Example

!!! example — a worked example.

Quote

!!! quote (alias: cite) — a quotation or citation.

Titles

The first argument is a custom title. Pass an empty string to render an admonition with no title bar.

Result Markdown

Pin your toolchain

Commit a global.json so every contributor builds with the same SDK.

A titleless admonition — just the colored body.

!!! tip "Pin your toolchain"

    Commit a `global.json` so every contributor builds with the same SDK.

!!! warning ""

    A titleless admonition — just the colored body.

Collapsible admonitions

Use ??? for a collapsed block and ???+ for one that starts expanded. Everything else is the same as !!!.

Result Markdown

Click to expand

Hidden until the reader opens it — great for optional detail or long output.

Expanded by default

Starts open, but the reader can collapse it.

??? note "Click to expand"

    Hidden until the reader opens it.

???+ info "Expanded by default"

    Starts open, but the reader can collapse it.

Content tabs

Group alternatives with === "Label". Tabs can contain any Markdown — prose, code, lists, even admonitions or nested tabs.

Result Markdown

sudo apt install ./netdocs_amd64.deb

.\netdocs.exe --help

docker run --rm -v "$PWD:/site" ghcr.io/xtremeownage/netdocs:latest build

=== "Debian / Ubuntu"

    ```bash
    sudo apt install ./netdocs_amd64.deb
    ```

=== "Windows"

    ```powershell
    .\netdocs.exe --help
    ```

=== "Docker"

    ```bash
    docker run --rm ... build
    ```

Link tabs across the page

Enable the content.tabs.link feature so that selecting a tab label (e.g. “Windows”) switches every tab group with that label on the page at once — handy for OS-specific instructions repeated throughout a document.

Admonitions inside tabs

Because tab content is ordinary Markdown, you can nest a call-out to draw attention within a single tab:

Result Markdown

Recommended

Pin a released version tag for reproducible builds.

Moves fast

latest tracks main and may change without notice.

=== "Stable"

    !!! success "Recommended"
        Pin a released version tag for reproducible builds.

=== "Edge"

    !!! warning "Moves fast"
        `latest` tracks `main` and may change without notice.

Enabling the extensions

Admonitions, collapsible details, and tabs are backed by these markdownExtensions entries (all included in the recommended configuration):

"markdownExtensions": [
  { "name": "admonition" },
  { "name": "pymdownx.details" },
  { "name": "pymdownx.superfences" },
  { "name": "pymdownx.tabbed", "options": { "alternate_style": true } }
]

See the full Markdown extensions reference for everything else in the pipeline.