Overview#

_images/logo-square.svg

MyST - Markedly Structured Text - Parser

A Sphinx and Docutils extension to parse MyST, a rich and extensible flavour of Markdown for authoring technical and scientific documentation.


CommonMark-plus

MyST extends the CommonMark syntax specification, to support technical authoring features such as tables and footnotes.

Sphinx compatible

Use the MyST role and directive syntax to harness the full capability of Sphinx, such as admonitions and figures, and all existing Sphinx extensions.

Highly configurable

MyST-parser can be configured at both the global and individual document level, to modify parsing behaviour and access extended syntax features.


Additional resources

MyST-Markdown VS Code extension

For MyST extended syntax highlighting and authoring tools.

Convert existing ReStructuredText files to Markdown

Use the rst-to-myst CLI or the MySTyc interactive web interface.

MyST-NB

A Sphinx and Docutils extension for compiling Jupyter Notebooks into high quality documentation formats, built on top of the MyST-Parser.

Jupyter Book

An open source project for building beautiful, publication-quality books and documents from computational material, built on top of the MyST-Parser and MyST-NB.

The Jupyter Book gallery

Examples of documents built with MyST.

Javascript MyST parser

The mystjs Javascript parser, allows you to parse MyST in websites.

markdown-it-py

A CommonMark-compliant and extensible Markdown parser, used by MyST-Parser to parse source text to tokens.

Acknowledgements

The MyST markdown language and MyST parser are both supported by the open community, The Executable Book Project.