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,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.

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-5.1.0.tar.gz (101.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

myst_docutils-5.1.0-py3-none-any.whl (85.9 kB view details)

Uploaded Python 3

File details

Details for the file myst_docutils-5.1.0.tar.gz.

File metadata

  • Download URL: myst_docutils-5.1.0.tar.gz
  • Upload date:
  • Size: 101.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.34.0

File hashes

Hashes for myst_docutils-5.1.0.tar.gz
Algorithm Hash digest
SHA256 42fa450dad69280051e87190f9fed426623b765f5f2944b50a72ea50d56f5fbf
MD5 7caf74a279f3046b8bbd288f0520cdc6
BLAKE2b-256 6fd8c7503010287315addb96f8f37329e820fdca1fe4f30e014e7c1b9b2b48ab

See more details on using hashes here.

File details

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

File metadata

  • Download URL: myst_docutils-5.1.0-py3-none-any.whl
  • Upload date:
  • Size: 85.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.34.0

File hashes

Hashes for myst_docutils-5.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1aef68c43af65f6b6a4c73fb388ac6e267edcac6863045079e7d5556aca829af
MD5 313dbfbaf5986497e158589c13324c11
BLAKE2b-256 895e88d8fb692688d50864c8d891d784dd3ac7111ce3a9fc49f287139de536ec

See more details on using hashes here.

Supported by

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