You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Chris Sewell 7556122193
📚 DOCS: Fix gallery link (#605)
2 weeks ago
.github/workflows ⬆️ Drop Sphinx 3, add Sphinx 5 (#579) 2 months ago
docs 📚 DOCS: Fix gallery link (#605) 2 weeks ago
myst_parser 🔧 MAINTAIN: Minor fixes (#585) 2 months ago
tests 🐛 FIX: `parse_directive_text` when body followed by options (#580) 2 months ago
.gitignore 🧪 TESTS: Add for `gettext_additional_targets` (#459) 8 months ago
.pre-commit-config.yaml [pre-commit.ci] pre-commit autoupdate (#603) 2 weeks ago
.readthedocs.yml ♻️📚 Restructure code base and documentation (#566) 3 months ago
CHANGELOG.md 🚀 RELEASE: 0.18.0 (#581) 2 months ago
LICENSE Initial commit 3 years ago
README.md 📚 DOCS: Refactoring and updating documentation (#385) 1 year ago
codecov.yml ⬆️ UPGRADE: sphinx v4 (& drop sphinx v2, change mathjax override) (#390) 1 year ago
example-include.md ♻️📚 Restructure code base and documentation (#566) 3 months ago
pyproject.toml ⬆️ Drop Sphinx 3, add Sphinx 5 (#579) 2 months ago
test.rst 🐛 FIX: `parse_directive_text` when body followed by options (#580) 2 months ago
tox.ini ⬆️ Drop Sphinx 3, add Sphinx 5 (#579) 2 months ago

README.md

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