Need help with MyST-Parser?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

executablebooks
137 Stars 32 Forks MIT License 232 Commits 49 Opened issues

Description

An extended commonmark compliant parser, with bridges to docutils/sphinx

Services available

!
?

Need anything else?

Contributors list

MyST-Parser

Github-CI Coverage Status Documentation Status Code style: black PyPI Conda PyPI - Downloads

An extended CommonMark-compliant parser, with bridges to Docutils and Sphinx.

Usage

To install the MyST parser, run the following in a Conda environment (recommended):

conda install -c conda-forge myst-parser

or

pip install myst-parser

Or for package development:

git clone https://github.com/executablebooks/MyST-Parser
cd MyST-Parser
git checkout master
pip install -e .[code_style,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 for more details.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.