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.16.1
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.16.1.tar.gz | 51.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| myst_docutils-0.16.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 100.6 kB
Release files / myst-docutils-0.16.1.tar.gz
| Download URL | myst-docutils-0.16.1.tar.gz |
|---|---|
| Size | 51.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
98a144e0b26a010874891f22225367aafab4c04d8ec5ebb25dbdaf9e32851258
|
|
BLAKE2b-256 checksum How to use checksums |
a0bf0998ae0ce8ae868d9b47c0d031cea4b18cc81ed2443a66def8419cbbc09a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12
|
Release files / myst_docutils-0.16.1-py3-none-any.whl
| Download URL | myst_docutils-0.16.1-py3-none-any.whl |
|---|---|
| Size | 48.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f1c5da5804091fc905bc83ac2fb04cd4515109e4843606d1c534c2ca74ebeed4
|
|
BLAKE2b-256 checksum How to use checksums |
2ed30fd1c4a34f7d3a67ff78770c41fbba47244c15f47eb5ba22da4420cf148d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12
|
