An extended [CommonMark](https://spec.commonmark.org/) compliant parser,
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-2.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7c36344ae39c8e740dad7fdabf5aa6fc4897a813083c6cc9990044eb93656b14 |
|
MD5 | 351d389014ef45256be25cc9ad328b7e |
|
BLAKE2b-256 | 1df66d61a023d758f488e36638076e8a4ec4447a2cdf86938cf6c60cf1c860e6 |