MyST - Markedly Structured Text _images/logo-square.svg¶

PyPI Conda

MyST is a rich and extensible flavor of Markdown meant for technical documentation and publishing.

MyST is a flavor of markdown that is designed for simplicity, flexibility, and extensibility. Here are a few major features

MyST is a superset of CommonMark Markdown. Any CommonMark document is also MyST-compliant.

MyST provides roles and directives, allowing you to extend MyST’s functionality.

MyST is inspired by Sphinx, and comes with its own Sphinx parser. Write your Sphinx docs in Markdown, or convert existing RST to Markdown!

This MyST parser is built on top of the markdown-it-py package, an pluggable Python parser for Markdown.

The Javascript parser builds on markdown-it, and allows you to parse MyST in websites.

Find the right documentation resources¶

This documentation is organized into a few major sections. Tutorials are step-by-step introductory guides to MyST Markdown. Topic Guides cover specific areas in more depth, and are organized as discrete “how-to” sections. Reference sections describe the API/syntax/etc of the MyST Parser in detail.

In addition, here are a few pointers to help you get started.

Get started with MyST

Get started with MyST in Sphinx: a step-by-step tutorial.

The MyST Syntax Guide: discusses major MyST syntax components.

The Sphinx guide: how to use MyST with your Sphinx documentation.

Learn more about MyST

Optional MyST Syntaxes: additional syntax you can enable for extra features.

The Python API guide: parsing and rendering MyST with Python.

Background and explanation: background understanding and discussions of MyST markdown.

Get inspired

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

The Jupyter Book gallery: examples of documents built with MyST.

Acknowledgements¶

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