Skip to main content

An extended [CommonMark](https://spec.commonmark.org/) compliant parser,

Project description

MyST-Parser

Note: myst-docutils is identical to myst-parser, but without installation requirements on sphinx

Github-CI Coverage Status Documentation Status Code style: black PyPI Conda PyPI - Downloads

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

myst-docutils-0.19.2.tar.gz (84.2 kB view details)

Uploaded Source

Built Distribution

myst_docutils-0.19.2-py3-none-any.whl (77.4 kB view details)

Uploaded Python 3

File details

Details for the file myst-docutils-0.19.2.tar.gz.

File metadata

  • Download URL: myst-docutils-0.19.2.tar.gz
  • Upload date:
  • Size: 84.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.2

File hashes

Hashes for myst-docutils-0.19.2.tar.gz
Algorithm Hash digest
SHA256 bbcd60d0fc3825cc0580cfb1f3872a00aa8ab7b2524f9750953938752948c74d
MD5 f36eb1fb5f13895b3d1179c5d43d65d3
BLAKE2b-256 1dbb9897c9951ff1f359242d88bde996a9cb7af294e15e70a24e1a0327feca51

See more details on using hashes here.

Provenance

File details

Details for the file myst_docutils-0.19.2-py3-none-any.whl.

File metadata

File hashes

Hashes for myst_docutils-0.19.2-py3-none-any.whl
Algorithm Hash digest
SHA256 541d2f5e276cedfb788b46c712b4394ac0d476fadeb4be0fa5dd79e4776fa9b5
MD5 1e5a260cfaefd352e215c32e905b948d
BLAKE2b-256 b09461e0d04a87ae3bcb6d78392f48af83f5f0b8e8f4c4c053e88c2c976012ae

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page