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.17.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.17.1.tar.gz | 61.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| myst_docutils-0.17.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 113.5 kB
Release files / myst-docutils-0.17.1.tar.gz
| Download URL | myst-docutils-0.17.1.tar.gz |
|---|---|
| Size | 61.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0c9567e30b40c46f9ec27b9c29cb5fe4946aca00970d856aac71e99f27d4be66
|
|
BLAKE2b-256 checksum How to use checksums |
10aa49ae64dc9c33cbb0fd67bb380d0dcd309cd21dc1abd8f9269b8c4034cfd2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.26.0
|
Release files / myst_docutils-0.17.1-py3-none-any.whl
| Download URL | myst_docutils-0.17.1-py3-none-any.whl |
|---|---|
| Size | 52.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8dba24d2c3e3c449e80096c99ff37645b01b65a31f58c925a8ff028e7eb5d469
|
|
BLAKE2b-256 checksum How to use checksums |
0b9e7f02ba9fc1c583cf276899d367918edc3c794192635b98cfa1791ea8c1f8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.26.0
|
