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 3.0.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-3.0.1.tar.gz | 92.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| myst_docutils-3.0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 175.7 kB
Release files / myst_docutils-3.0.1.tar.gz
| Download URL | myst_docutils-3.0.1.tar.gz |
|---|---|
| Size | 92.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6a542f1743963630dc934db6391275365e2dd638333192846c9c4f1ecae605c2
|
|
BLAKE2b-256 checksum How to use checksums |
6613b81a3c36c0709e1c8960bd39a4cdb5a3b6295ee147855d1283880dd1299f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.31.0
|
Release files / myst_docutils-3.0.1-py3-none-any.whl
| Download URL | myst_docutils-3.0.1-py3-none-any.whl |
|---|---|
| Size | 83.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b7db7ff8d10cd79c89f639134a2cc13f42b6ec22036785763cf11036f7dc1804
|
|
BLAKE2b-256 checksum How to use checksums |
d4b160f16eb31a52d123118325c49400ce1f2a2a42d36ace8e7ec7543a7e8c73
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.31.0
|
