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.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8dba24d2c3e3c449e80096c99ff37645b01b65a31f58c925a8ff028e7eb5d469 |
|
MD5 | 047e631ff33c24d662d0b217709bc0b2 |
|
BLAKE2b-256 | 0b9e7f02ba9fc1c583cf276899d367918edc3c794192635b98cfa1791ea8c1f8 |