Messages¶

Extensions: admonition, pymdownx.details, pymdownx.quotes

Admonitions render as Bifrost Message components. Two syntaxes produce them: the standard !!! syntax (from the admonition extension) and GitHub-style alert blocks using > [!TYPE] (from pymdownx.quotes with callouts enabled).

Deprecated: github-callouts

Earlier versions of this guide used the github-callouts extension. It still works, but the theme stops installing markdown-callouts in a future release. Replace github-callouts = {} with pymdownx.quotes.callouts = true in your config.

GitHub Alert Syntax¶

ResultMarkdown

Note

Useful for highlighting information that users should take into account.

Tip

Helpful advice for getting the most out of a feature.

Important

Key information users need to know.

Warning

Something that could cause problems if ignored.

Caution

Actions that are irreversible or could cause data loss.

> [!NOTE]
> Useful for highlighting information that users should take into account.

> [!TIP]
> Helpful advice for getting the most out of a feature.

> [!IMPORTANT]
> Key information users need to know.

> [!WARNING]
> Something that could cause problems if ignored.

> [!CAUTION]
> Actions that are irreversible or could cause data loss.

GitHub Alert Titles and Folding¶

ResultMarkdown

Custom title

Text after the type replaces the default title.

Collapsed by default

A trailing - makes the alert collapsible and closed. Use + to start it open.

> [!WARNING] Custom title
> Text after the type replaces the default title.

> [!TIP]- Collapsed by default
> A trailing `-` makes the alert collapsible and closed. Use `+` to start it open.

All 12 Message Types¶

ResultMarkdown

Note

Useful for highlighting information that users should take into account.

Abstract

A brief summary of the content that follows.

Info

Supplementary information that adds context.

Tip

Helpful advice for getting the most out of a feature.

Success

Indicates that an action completed as expected.

Question

Prompts the reader to think about something or highlights common questions.

Warning

Something that could cause problems if ignored.

Failure

Indicates that something did not work or is not supported.

Danger

Actions that are irreversible or could cause data loss.

Bug

Known issues or unexpected behavior.

Example

A practical demonstration of a concept.

Quote

A citation or noteworthy statement.

!!! note "Note"
    Useful for highlighting information.

!!! abstract "Abstract"
    A brief summary of the content.

!!! info "Info"
    Supplementary information.

!!! tip "Tip"
    Helpful advice.

!!! success "Success"
    Indicates that an action completed.

!!! question "Question"
    Highlights common questions.

!!! warning "Warning"
    Something that could cause problems.

!!! failure "Failure"
    Something did not work.

!!! danger "Danger"
    Irreversible or destructive actions.

!!! bug "Bug"
    Known issues or unexpected behavior.

!!! example "Example"
    A practical demonstration.

!!! quote "Quote"
    A citation or noteworthy statement.

Collapsible Messages¶

ResultMarkdown

Collapsed by default (click to expand)

This content is hidden until the reader clicks the header. You can put any content here, including code blocks and lists.

Expanded by default (click to collapse)

This message starts open but can be collapsed by clicking the header.

??? note "Collapsed by default (click to expand)"
    This content is hidden until the reader clicks.

???+ tip "Expanded by default (click to collapse)"
    This message starts open but can be collapsed.

Syntax Comparison¶

GitHub Alerts	Standard Syntax
`> [!NOTE]`	`!!! note`
`> [!TIP]`	`!!! tip`
`> [!IMPORTANT]`	`!!! info`
`> [!WARNING]`	`!!! warning`
`> [!CAUTION]`	`!!! danger`

The standard !!! syntax gives access to all 12 types. GitHub alerts are limited to 5 types but work on GitHub and other renderers too. Both support custom titles and collapsible blocks.