An extended commonmark compliant parser, with bridges to docutils & sphinx.
Project description
MyST-Parser
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-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.
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_parser-0.18.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4965e51918837c13bf1c6f6fe2c6bddddf193148360fbdaefe743a4981358f6a |
|
MD5 | fe98ffd18f689ca121af79fd266ac2b4 |
|
BLAKE2b-256 | 51545474560bde8b1de464d59e976940ac07e78caead070c67da776f0428bf18 |