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.
1 maintainer
Metadata
1 maintainer
Release files for myst-docutils 0.19.2
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-docutils-0.19.2.tar.gz | 84.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| myst_docutils-0.19.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 161.6 kB
Release files / myst-docutils-0.19.2.tar.gz
| Download URL | myst-docutils-0.19.2.tar.gz |
|---|---|
| Size | 84.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bbcd60d0fc3825cc0580cfb1f3872a00aa8ab7b2524f9750953938752948c74d
|
|
BLAKE2b-256 checksum How to use checksums |
1dbb9897c9951ff1f359242d88bde996a9cb7af294e15e70a24e1a0327feca51
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.28.2
|
Release files / myst_docutils-0.19.2-py3-none-any.whl
| Download URL | myst_docutils-0.19.2-py3-none-any.whl |
|---|---|
| Size | 77.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
541d2f5e276cedfb788b46c712b4394ac0d476fadeb4be0fa5dd79e4776fa9b5
|
|
BLAKE2b-256 checksum How to use checksums |
b09461e0d04a87ae3bcb6d78392f48af83f5f0b8e8f4c4c053e88c2c976012ae
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.28.2
|
