🔎 Overview#
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.
MyST extends the CommonMark syntax specification, to support technical authoring features such as tables and footnotes.
Use the MyST role and directive syntax to harness the full capability of Sphinx, such as admonitions and figures, and all existing Sphinx extensions.
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.
- 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.