Skip to article frontmatter Skip to article content

Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

myst-theme documentation User Interface Components Permalinks and URLs

Visual Reference

Admonitions Blocks Computation and notebooks Images & Figures Lists Long Content Structure Tables Typography

Developer Guide

Custom Footer | GitHub

Admonitions

Basic Admonitions¶

Note

This is a note admonition.

Tip

This is a tip admonition.

Warning

This is a warning admonition.

Important

This is an important admonition.

Danger

This is a danger admonition.

With Custom Title¶

Custom Title

Admonitions can have custom titles.

Proceed with Caution

Warnings with descriptive titles.

Nested Admonitions¶

Note

Outer note admonition.

Warning

Nested warning inside the note.

Back to outer note.

Rich Content¶

With Code and Lists

Admonitions can contain:

Lists and formatting
Code blocks

def example():
    return "Hello!"

Dropdowns¶

Click to Expand

Hidden content that expands on click.

Note

Admonitions can use :class: dropdown to be collapsible.

myst-theme documentation

Visual Reference

myst-theme documentation

Demo Footer: Made with MyST