An extended commonmark compliant parser, with bridges to docutils & sphinx.
Project description
MyST-Parser
Note: myst-docutils is identical to myst-parser, but without installation requirements on sphinx
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-compliant parser using markdown-it-py, as well as a Sphinx extension that allows you to write MyST Markdown in Sphinx.
See the MyST Parser documentation for more information.
Installation
To install the MyST parser, run the following in a Conda environment (recommended):
conda install -c conda-forge myst-docutils
or
pip install myst-docutils
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for myst_docutils-0.18.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c5cc5681fbc47f407565aff4b481744fe3be5ae8cd7c1c8679bb2d9df1d5eeca |
|
| MD5 | 9b24edd92e73089549f74eedfe31e33a |
|
| BLAKE2b-256 | c1a4f067ddef92e910a36378a6e2ab4dd209ab8270ef663c257619edb242c5dc |
