freshcrate
Home > Frameworks > myst-parser

myst-parser

An extended [CommonMark](https://spec.commonmark.org/) compliant parser,

developmentdocutilslexermarkdownparserpypisphinx

Description

# MyST-Parser [![Github-CI][github-ci]][github-link] [![Coverage Status][codecov-badge]][codecov-link] [![Documentation Status][rtd-badge]][rtd-link] [![Code style: black][black-badge]][black-link] [![PyPI][pypi-badge]][pypi-link] [![Conda][conda-badge]][conda-link] [![PyPI - Downloads][install-badge]][install-link] **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. This repository serves as the reference implementation of MyST Markdown, as well as a collection of tools to support working with MyST in Python and Sphinx. It contains an extended [CommonMark](https://commonmark.org)-compliant parser using [`markdown-it-py`](https://markdown-it-py.readthedocs.io/), as well as a [Sphinx](https://www.sphinx-doc.org) extension that allows you to write MyST Markdown in Sphinx. [**See the MyST Parser documentation for more information**](https://myst-parser.readthedocs.io/en/latest/). ## Installation To install the MyST parser, run the following in a [Conda environment](https://docs.conda.io) (recommended): ```bash conda install -c conda-forge myst-parser ``` or ```bash pip install myst-parser ``` Or for package development: ```bash git clone https://github.com/executablebooks/MyST-Parser cd MyST-Parser git checkout master pip install -e .[code_style,linkify,testing,rtd] ``` To use the MyST parser in Sphinx, simply add: `extensions = ["myst_parser"]` to your `conf.py`. ## Contributing We welcome all contributions! See the [Contributing Guide](https://myst-parser.readthedocs.io/en/latest/develop/index.html) for more details. [github-ci]: https://github.com/executablebooks/MyST-Parser/workflows/continuous-integration/badge.svg?branch=master [github-link]: https://github.com/executablebooks/MyST-Parser [codecov-badge]: https://codecov.io/gh/executablebooks/MyST-Parser/branch/master/graph/badge.svg [codecov-link]: https://codecov.io/gh/executablebooks/MyST-Parser [rtd-badge]: https://readthedocs.org/projects/myst-parser/badge/?version=latest [rtd-link]: https://myst-parser.readthedocs.io/en/latest/?badge=latest [black-badge]: https://img.shields.io/badge/code%20style-black-000000.svg [pypi-badge]: https://img.shields.io/pypi/v/myst-parser.svg [pypi-link]: https://pypi.org/project/myst-parser [conda-badge]: https://anaconda.org/conda-forge/myst-parser/badges/version.svg [conda-link]: https://anaconda.org/conda-forge/myst-parser [black-link]: https://github.com/ambv/black [install-badge]: https://img.shields.io/pypi/dw/myst-parser?label=pypi%20installs [install-link]: https://pypistats.org/packages/myst-parser

Release History

VersionChangesUrgencyDate
5.0.0Imported from PyPI (5.0.0)Low4/21/2026
v5.0.0# MyST-Parser 5.0.0 **Release Date**: 2026-01-15 This release significantly bumps the supported versions of core dependencies: ## ‼️ Breaking Changes This release updates the minimum supported versions: - **Python**: `>=3.11` (dropped Python 3.10, tests up to 3.14) - **Sphinx**: `>=8,<10` (dropped Sphinx 7, added Sphinx 9) - **Docutils**: `>=0.20,<0.23` (dropped docutils 0.19, added docutils 0.22) - **markdown-it-py**: `~=4.0` (upgraded from v3) ## ⬆️ Dependency Upgrades Low1/15/2026
v4.0.1## What's Changed * 🔧 Minor fix for sphinx 8.2 compat by @chrisjsewell in https://github.com/executablebooks/MyST-Parser/pull/1013 * 🧪 Add CI testing support for Python 3.13 by @hugovk in https://github.com/executablebooks/MyST-Parser/pull/955 * 🔧 Fix type of MockIncludeDirective’s `klass` parameter by @flying-sheep in https://github.com/executablebooks/MyST-Parser/pull/975 * 📚 Fix typos discovered by codespell by @cclauss in https://github.com/executablebooks/MyST-Parser/pull/969 Low2/12/2025
v4.0.0## What's Changed * ⬆️ Support python>=3.10, sphinx >=7,<9, docutils>=0.19,<0.22 by @chrisjsewell in https://github.com/executablebooks/MyST-Parser/pull/952 * 👌 Improve footnote def/ref warnings and translations by @chrisjsewell in https://github.com/executablebooks/MyST-Parser/pull/931 * 📚 Fix typo by @meli-lewis in https://github.com/executablebooks/MyST-Parser/pull/940 ## New Contributors * @meli-lewis made their first contribution in https://github.com/executablebooks/MyST-Parser/Low8/5/2024
v3.0.1## What's Changed * 🐛 FIX empty value for final directive option by @chrisjsewell in https://github.com/executablebooks/MyST-Parser/pull/924 * 🐛 FIX: allow indented option block by @chrisjsewell in https://github.com/executablebooks/MyST-Parser/pull/925 **Full Changelog**: https://github.com/executablebooks/MyST-Parser/compare/v3.0.0...v3.0.1Low4/28/2024
v3.0.0## What's Changed ### Upgraded dependencies * ⬆️ Add support for Python 3.12 by @hugovk in https://github.com/executablebooks/MyST-Parser/pull/848 * ⬆️ Update docutils requirement from >=0.16,<0.21 to >=0.18,<0.22 by @chrisjsewell in https://github.com/executablebooks/MyST-Parser/pull/916 ### New features * ✨ Allow for use of the `line-block` directive by @chrisjsewell in https://github.com/executablebooks/MyST-Parser/pull/900 * ✨ Emits sphinx include-read event by @sumezulike in hLow4/23/2024
v2.0.0This release primarily updates core myst-parser dependencies, with some minor changes to parsing behaviour: * ⬆️ UPGRADE: `markdown-it-py` to v3 (https://github.com/executablebooks/MyST-Parser/pull/773) * This is mainly a non-breaking change, fixing some edge cases in parsing * See: <https://github.com/executablebooks/markdown-it-py/releases/tag/v3.0.0> and <https://github.com/executablebooks/mdit-py-plugins/releases/tag/v0.4.0> * ⬆️ UPGRADE: `linkify-it-py` to v2 (https://githLow6/13/2023
v1.0.0🎉 **MyST-Parser 1.0.0** 🎉 This changes absolutely nothing in the code, or about the maintenance/release policy of this project. But it does feel about time 😄 Low3/7/2023
v0.19.2## What's Changed * ✨ NEW: Add `myst_fence_as_directive` config by @chrisjsewell in https://github.com/executablebooks/MyST-Parser/pull/742 Setting the following config, for example: ```python extensions = ["myst_parser", "sphinxcontrib.mermaid"] myst_fence_as_directive = ["mermaid"] # optional to use directive options myst_enable_extensions = ["attrs_block"] ``` allows for one to write: ````markdown {caption="My caption"} {alt="HTML alt" align=center} ```mermaid graph LRLow3/7/2023
v0.19.1## What's Changed * 🐛 FIX NoURI error in doc reference resolution, for texinfo builds by @chrisjsewell in https://github.com/executablebooks/MyST-Parser/pull/734 **Full Changelog**: https://github.com/executablebooks/MyST-Parser/compare/v0.19.0...v0.19.1Low3/2/2023
v0.19.0This release brings a number of exciting new features, improvements, and upgrades 🎉 https://myst-parser.readthedocs.io - 📚 Rewritten documentation, with a clearer structure, many more examples, rich hover tips, and a new live preview page (powered by pyscript) - The code base API is also now fully documented by https://sphinx-autodoc2.readthedocs.io/, which even allows for MyST docstrings! - ⬆️ Add Sphinx 6 support - 📄 Extended docutils (single-page) support - 🔗 Extended Markdown lLow3/1/2023
v0.18.1## What's Changed * 🔧 MAINTAIN: Minor fixes by @chrisjsewell in https://github.com/executablebooks/MyST-Parser/pull/585 * [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/executablebooks/MyST-Parser/pull/586 * 📚 DOCS: redundant trailing `)` by @Ab2nour in https://github.com/executablebooks/MyST-Parser/pull/588 * [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/executablebooks/MyST-Parser/pull/595 * 📚 DOCS: Fix typos in syntax.md bLow9/27/2022
v0.18.0## What's Changed * 👌 IMPROVE: Do not let sphinx check the config type by @chrisjsewell in https://github.com/executablebooks/MyST-Parser/pull/559 * ♻️📚 Restructure code base and documentation by @chrisjsewell in https://github.com/executablebooks/MyST-Parser/pull/566 * 🐛 FIX: floor table column widths to integers by @Jean-Abou-Samra in https://github.com/executablebooks/MyST-Parser/pull/568 * ⬆️ Drop Sphinx 3, add Sphinx 5 by @chrisjsewell in https://github.com/executablebooks/MyST-ParseLow6/7/2022
v0.17.2## What's Changed * ♻️ REFACTOR: Replace attrs by dataclasses by @chrisjsewell in https://github.com/executablebooks/MyST-Parser/pull/557 **Full Changelog**: https://github.com/executablebooks/MyST-Parser/compare/v0.17.1...v0.17.2Low4/17/2022
v0.17.1## What's Changed * 📚 DOC: Update auto-generated header anchors section by @choldgraf in https://github.com/executablebooks/MyST-Parser/pull/524 * 🐛 FIX: Heading anchor resolution for parallel builds by @chrisjsewell in https://github.com/executablebooks/MyST-Parser/pull/525 * 📚 DOCS: Fix typo by @rowanc1 in https://github.com/executablebooks/MyST-Parser/pull/526 * 📚 DOCS: Fix typos by @kianmeng in https://github.com/executablebooks/MyST-Parser/pull/535 * 🔧 MAINTAIN: Change git to httpLow4/15/2022
v0.17.0See: https://myst-parser.readthedocs.io/en/latest/develop/_changelog.html ## What's Changed * 👌 IMPROVE: Add `bullet` attribute to `bullet_list` node by @chrisjsewell in https://github.com/executablebooks/MyST-Parser/pull/465 * 👌 IMPROVE: Use correct renderer for `state.inline_text` by @chrisjsewell in https://github.com/executablebooks/MyST-Parser/pull/466 * 🧪 TESTS: Use `publish_doctree` to test error reporting by @chrisjsewell in https://github.com/executablebooks/MyST-Parser/pull/47Low2/11/2022
v0.16.1## What's Changed * 📚 DOCS: Fix myst-docutils README by @jpmckinney in https://github.com/executablebooks/MyST-Parser/pull/462 * ✨ NEW: Add `myst_linkify_fuzzy_links` option by @chrisjsewell in https://github.com/executablebooks/MyST-Parser/pull/464 **Full Changelog**: https://github.com/executablebooks/MyST-Parser/compare/v0.16.0...v0.16.1Low12/16/2021
v0.16.0## What's Changed * 🚀 RELEASE: v0.15.2 (maintenance release) by @mmcky in https://github.com/executablebooks/MyST-Parser/pull/423 * FIX: Add mandatory attributes on enumerated_list by @cpitclaudel in https://github.com/executablebooks/MyST-Parser/pull/418 * 📚 DOCS: Add reference to MySTyc in landing page by @astrojuanlu in https://github.com/executablebooks/MyST-Parser/pull/413 * [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/executablebooks/MyST-Parser/pull/Low12/11/2021
v0.15.2Release v0.15.2Low8/27/2021
v0.15.1See [CHANGELOG.md](https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md)Low6/17/2021
v0.15.0See [CHANGELOG.md](https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md)Low6/12/2021
v0.14.0See [CHANGELOG.md](https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md)Low5/4/2021
v0.14.0a3Alpha release of v0.14.0a3, for testing myst-nbLow5/1/2021
v0.14.0a2Alpha release of v0.14.0a2, for testing myst-nbLow4/25/2021
v0.14.0a1Alpha release of v0.14.0a1, for testing myst-nbLow4/25/2021
v0.13.7See [CHANGELOG.md](https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md)Low4/24/2021
v0.13.6See [CHANGELOG.md](https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md)Low4/9/2021
v0.13.5See [CHANGELOG.md](https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md)Low2/15/2021
v0.13.3See CHANGELOG.mdLow1/20/2021
v0.13.2See [CHANGELOG.md](https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md)Low1/20/2021
v0.13.1See [CHANGELOG.md](https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md)Low12/31/2020
v0.13.0See [CHANGELOG.md](https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md)Low12/18/2020
v0.12.10See [CHANGELOG.md](https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md)Low9/21/2020
v0.12.9See [CHANGELOG.md](https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md)Low9/8/2020
v0.12.8See [CHANGELOG.md](https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md) Low9/1/2020
v0.12.7See [CHANGELOG.md](https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md)Low8/31/2020
v0.12.6See [CHANGELOG.md](https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md)Low8/28/2020
v0.12.5See [CHANGELOG.md](https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md)Low8/27/2020
v0.12.4See [CHANGELOG.md](https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md)Low8/26/2020
v0.12.3See [CHANGELOG.md](https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md)Low8/26/2020
v0.12.2See [CHANGELOG.md](https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md)Low8/25/2020
v0.12.1See [CHANGELOG.md](https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md)Low8/21/2020
v0.12.0See [CHANGELOG.md](https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md)Low8/19/2020
v0.11.2See [CHANGELOG.md](https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md) for infoLow8/13/2020
v0.11.1See [CHANGELOG.md](https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md) for infoLow8/12/2020
v0.11.0See [CHANGELOG.md](https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md) for infoLow8/12/2020
v0.10.0See [CHANGELOG.md](https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md) for infoLow8/7/2020
v0.9.1Also updates to documentation CLILow7/20/2020
v0.9.0`sphinx` was originally an extra requirement, when `myst-parser` also contained markdown parsing extensions. This is all contained in `markdown-it-py` now, so there is generally no use case for `myst-parser` without sphinxLow6/22/2020
v0.8.2Release v0.8.2Low6/12/2020
v0.8.1This is required by docutils/sphinx, which expects inline content to be within a block level parent. For example, for URL references this was causing build failures, as noted in #127. Thanks to @martinagvilas for the PRLow4/15/2020

Dependencies & License Audit

Loading dependencies...

Similar Packages

inquirerpyPython port of Inquirer.js (A collection of common interactive command-line user interfaces)0.3.4
doclingSDK and CLI for parsing PDF, DOCX, HTML, and more, to a unified document representation for powering downstream workflows such as gen AI applications.2.90.0
sphinx-designA sphinx extension for designing beautiful, view size responsive web components.0.7.0
openapi-pydanticPydantic OpenAPI schema implementation0.5.1
pre-commitA framework for managing and maintaining multi-language pre-commit hooks.v4.6.0