Skip to article frontmatterSkip to article content
Site not loading correctly?

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

You can use a .md file as a regular Jupyter Book page.

Why This Matters

MyST Features Demo

MyST Markdown adds several website-aware enhancements beyond plain markdown. Use these features in .md pages and they will render on the Jupyter Book website.

Admonitions

MyST admonitions are a great way to add callouts, tips, warnings, and notes.
This warning block is usually visible on the built site but may not appear correctly in simple markdown previews.

Cross references

You can reference sections, figures, and pages directly from the site.

See the MyST docs for examples.

Task lists

Definition list

Term
Definition text that explains the term.

Inline math

Set notation example: S={xR:x2>0}S = \{x \in \mathbb{R} : x^2 > 0\}

Code block with syntax highlighting

print('MyST pages can still show code, and code blocks render on the website.')

Visibility Note

Some MyST-specific features may not render exactly in a plain markdown preview. They are designed for the Jupyter Book website and will look correct after site build.

Interactive Components Showcase

This template demonstrates interactive components supported by Jupyter Book and MyST Markdown. These features help create clean, interactive, and user-friendly documentation.


Click to learn about Jupyter Book

Jupyter Book is an open-source tool for building beautiful, publication-quality books and websites from computational content.

It supports:

  • Jupyter Notebooks

  • Markdown

  • LaTeX

  • Interactive content

  • JupyterLite

Learn more


Toggle (Collapsible Dropdown)

Show / Hide Content

This content appears when clicked.

You can include:

  • Text

  • Code

  • Images

  • Plots

  • Tables

This makes your content cleaner and easier to navigate.


Admonition Dropdown (Professional Style)


Tabs Example

Python
Markdown
Output
print("Hello from Python")

Wikipedia Popup Example

Learn about Python (Wikipedia Preview)

Tooltip Example

This template supports glossary tooltips like Jupyter Book.

Jupyter Book
An open-source tool for building interactive books and documentation using MyST Markdown.

Callout Example

print("Hello Pyodide")