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,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
Metadata
1 maintainer
Release files for myst-docutils 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_docutils-5.1.0.tar.gz | 101.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| myst_docutils-5.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 187.1 kB
Release files / myst_docutils-5.1.0.tar.gz
| Download URL | myst_docutils-5.1.0.tar.gz |
|---|---|
| Size | 101.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
42fa450dad69280051e87190f9fed426623b765f5f2944b50a72ea50d56f5fbf
|
|
BLAKE2b-256 checksum How to use checksums |
6fd8c7503010287315addb96f8f37329e820fdca1fe4f30e014e7c1b9b2b48ab
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.34.0
|
Release files / myst_docutils-5.1.0-py3-none-any.whl
| Download URL | myst_docutils-5.1.0-py3-none-any.whl |
|---|---|
| Size | 85.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1aef68c43af65f6b6a4c73fb388ac6e267edcac6863045079e7d5556aca829af
|
|
BLAKE2b-256 checksum How to use checksums |
895e88d8fb692688d50864c8d891d784dd3ac7111ce3a9fc49f287139de536ec
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.34.0
|
