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,linkify,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.
1 maintainer
Release files for myst-parser 5.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| myst_parser-5.1.0.tar.gz | 101.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| myst_parser-5.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 187.0 kB
Release files / myst_parser-5.1.0.tar.gz
| Download URL | myst_parser-5.1.0.tar.gz |
|---|---|
| Size | 101.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ab69322dc6719dcc7f296479dbb70181b66df6ed315064f92dbc85c0e1bf2f02
|
|
BLAKE2b-256 checksum How to use checksums |
21dc603751677fff302f34396e206b610f556a59d7fe58b9a2145f54e96b48e8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.34.0
|
Release files / myst_parser-5.1.0-py3-none-any.whl
| Download URL | myst_parser-5.1.0-py3-none-any.whl |
|---|---|
| Size | 85.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9c91c52b3cdb4d94a6506e4fab4e2f296c7623a0da0dcbe6de1565c3dad67a8a
|
|
BLAKE2b-256 checksum How to use checksums |
09dcf3dfb7488b770f3f67e6545085bf2abea5172e88f57b8ad25ef860ca704c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.34.0
|
