Jupyter Book inherits MyST Markdown’s full authoring feature set. The pages below cover the most common features, and the sections after that link to the MyST guide for deeper reference.
- Introduction to MyST Markdown
- Math and equations
- Add authors and their information to a page
- Use roles and directives
- Table of contents structure
- Supported file types
Typography¶
MyST extends CommonMark with footnotes, definition lists, subscripts and superscripts, smart-quotes, and other typographic features. See Typography.
Admonitions¶
Callout boxes for notes, warnings, tips, and other side content. Admonitions can be collapsed by default and support custom titles and classes. See Callouts & Admonitions.
Figures¶
Embed images with captions, labels, alignment, and width controls. Figures can be cross-referenced from anywhere in your book. See Images, Figures and Videos.
Tables¶
Author tables in Markdown or load them from external CSV/TSV files, with support for captions, labels, and column alignment. See Tables.
Code blocks¶
Syntax-highlighted code with line numbers, emphasized lines, captions, and filenames. See Code and Code-blocks.
Dropdowns, cards, and tabs¶
Interactive content layouts for collapsible details, card grids, and tabbed panels. See Dropdowns, Grids, Tabs and Cards.
Diagrams¶
Render Mermaid diagrams (flowcharts, sequence diagrams, etc.) directly in your pages. See Diagrams.
Asides and marginalia¶
Place content in the page margin as a sidenote or aside. See Asides, Margin Content, and Sidebars.
Blocks¶
Group content into logical blocks that share metadata, classes, or visibility settings. See Blocks and Comments.
Citations and bibliographies¶
Cite from a BibTeX file using @key syntax and render a formatted reference list. See Citations and Bibliography.
Cross-references¶
Label any element (figures, equations, sections, tables) and reference it from anywhere in your book. See Cross-references and the tutorial.
External references¶
Link to Wikipedia, DOIs, GitHub source, RRIDs, and other MyST sites with rich previews on hover. See External References.
Embeds and reuse¶
Embed content from other pages or external sources to keep documentation DRY. See Embed & Include Content.
Proofs and theorems¶
Numbered, cross-referenceable proofs, theorems, lemmas, and corollaries. See Proofs, Theorems and Algorithms.
Exercises¶
Author exercises with optional solutions that can be hidden or shown. See Exercises and Solutions.
Glossaries and terms¶
Define terms once and reference them throughout your book. See Glossaries, Terms, Index Pages, and Abbreviations.
Writing in LaTeX¶
Embed raw LaTeX for formulas or content that benefits from the LaTeX ecosystem. See Writing in LaTeX.
Inline options for classes and configuration¶
Configure directives and roles using compact inline option syntax. See Inline Options.
Quick links¶
MyST Markdown specification - Full syntax reference
MyST guide - Complete MyST documentation