Skip to content

An extended commonmark compliant parser, with bridges to docutils/sphinx (中文)

License

Notifications You must be signed in to change notification settings

daobook/MyST-Parser

This branch is 6 commits ahead of, 3 commits behind executablebooks/MyST-Parser:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

c270d1c · Dec 27, 2024
Dec 23, 2024
Dec 27, 2024
Dec 27, 2024
Sep 13, 2024
Oct 27, 2024
Nov 27, 2023
Oct 27, 2024
Aug 2, 2024
Sep 10, 2024
Feb 13, 2020
Jan 11, 2024
Feb 21, 2023
May 12, 2022
Oct 27, 2024
Dec 23, 2024
Aug 5, 2024

Repository files navigation

MyST-Parser

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-parser

or

pip install myst-parser

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.

About

An extended commonmark compliant parser, with bridges to docutils/sphinx (中文)

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 89.8%
  • HTML 10.1%
  • Shell 0.1%