Sitemap

🧠 Regularly Used MyST Syntax

Create Beautiful, Interactive, and Executable Technical Books

2 min readJul 27, 2025

--

Press enter or click to view image in full size

πŸ“Œ Introduction

MyST (Markedly Structured Text) extends Markdown with additional syntax for scholarly content, code execution, and interactivity. This guide introduces commonly used MyST syntax for authoring content in Jupyter Book 2. MyST (Markedly Structured Text) extends Markdown with powerful features like directives, executable code cells, math rendering, cross-references, and more β€” ideal for technical writing and interactive documentation.

✍️ Writing in MyST Markdown

MyST Markdown supports all basic Markdown plus:

1. πŸ“‘ Headers

# Chapter Title
## Section Title
### Subsection

2. 🧩 Directives

Use double colons and directives like in reStructuredText:

```{note}
This is a **note** box.,
{warning}
Be cautious with this!
{margin}
This content appears in the margin.

3. πŸ“˜ Admonitions (Tips, Warnings, etc.)

```md
```{admonition} Try this out!
You can create custom admonitions too.

--

--

Dr. Shouke Wei
Dr. Shouke Wei

Written by Dr. Shouke Wei

Professor and Scientist in data analysis and modelling, machine learnig, and computer vision. Support my writing: https://medium.com/@shouke.wei/membership

No responses yet