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.
Project 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.17.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 980a69ee31b18e4381ac62eda59170ade4eba56b2ef07950878d0428fa1983c5 |
|
MD5 | 9feef287c2c2679c588f92ed14d66f64 |
|
BLAKE2b-256 | 8120e044f45c147672b8678d8c4138f8a56b6c105bb4e119a6a744e355b9fdfe |