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

Uploaded Source

Built Distribution

myst_docutils-4.0.1-py3-none-any.whl (84.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for myst_docutils-4.0.1.tar.gz
Algorithm Hash digest
SHA256 53944c454d1765d8e204ac8d05f6ba925bc3cff6293769ab83c1ccdd2e7c1ce0
MD5 69cd2dbf87ca939cbadd0b67bf54c3c2
BLAKE2b-256 1c4718f088f2cbdebc58740b930058c571532989f666b7d13f016a8f625c54a7

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for myst_docutils-4.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 33542a9ebf1abbbb760b0cb9822b2c502c7592d58eb3bd8df81b7513a1df9a85
MD5 e98a2cd80a87b661c9b0ff4d65526f83
BLAKE2b-256 962ce49fc2995711f7d9096a1cfcb3494619d313c7d3a2d98f0e2d7258ab9eb9

See more details on using hashes here.

Supported by

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