/MyST-Parser

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

Primary LanguagePythonMIT LicenseMIT

MyST-Parser

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

An extended commonmark compliant parser, with bridges to docutils & 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.