Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/executablebooks/MyST-Parser
An extended commonmark compliant parser, with bridges to docutils/sphinx
https://github.com/executablebooks/MyST-Parser
docutils markdown-parser sphinx sphinx-extension
Last synced: about 2 months ago
JSON representation
An extended commonmark compliant parser, with bridges to docutils/sphinx
- Host: GitHub
- URL: https://github.com/executablebooks/MyST-Parser
- Owner: executablebooks
- License: mit
- Created: 2020-02-13T01:23:01.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-08-05T16:55:53.000Z (about 2 months ago)
- Last Synced: 2024-08-06T14:21:52.320Z (about 2 months ago)
- Topics: docutils, markdown-parser, sphinx, sphinx-extension
- Language: Python
- Homepage: https://myst-parser.readthedocs.io
- Size: 1.97 MB
- Stars: 722
- Watchers: 23
- Forks: 191
- Open Issues: 171
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# MyST-Parser
[![Github-CI][github-ci]][github-link]
[![Coverage Status][codecov-badge]][codecov-link]
[![Documentation Status][rtd-badge]][rtd-link]
[![Code style: black][black-badge]][black-link]
[![PyPI][pypi-badge]][pypi-link]
[![Conda][conda-badge]][conda-link]
[![PyPI - Downloads][install-badge]][install-link]
**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](https://commonmark.org)-compliant parser using [`markdown-it-py`](https://markdown-it-py.readthedocs.io/), as well as a [Sphinx](https://www.sphinx-doc.org) extension that allows you to write MyST Markdown in Sphinx.
[**See the MyST Parser documentation for more information**](https://myst-parser.readthedocs.io/en/latest/).
## Installation
To install the MyST parser, run the following in a
[Conda environment](https://docs.conda.io) (recommended):
```bash
conda install -c conda-forge myst-parser
```
or
```bash
pip install myst-parser
```
Or for package development:
```bash
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](https://myst-parser.readthedocs.io/en/latest/develop/index.html) for more details.
[github-ci]: https://github.com/executablebooks/MyST-Parser/workflows/continuous-integration/badge.svg?branch=master
[github-link]: https://github.com/executablebooks/MyST-Parser
[codecov-badge]: https://codecov.io/gh/executablebooks/MyST-Parser/branch/master/graph/badge.svg
[codecov-link]: https://codecov.io/gh/executablebooks/MyST-Parser
[rtd-badge]: https://readthedocs.org/projects/myst-parser/badge/?version=latest
[rtd-link]: https://myst-parser.readthedocs.io/en/latest/?badge=latest
[black-badge]: https://img.shields.io/badge/code%20style-black-000000.svg
[pypi-badge]: https://img.shields.io/pypi/v/myst-parser.svg
[pypi-link]: https://pypi.org/project/myst-parser
[conda-badge]: https://anaconda.org/conda-forge/myst-parser/badges/version.svg
[conda-link]: https://anaconda.org/conda-forge/myst-parser
[black-link]: https://github.com/ambv/black
[install-badge]: https://img.shields.io/pypi/dw/myst-parser?label=pypi%20installs
[install-link]: https://pypistats.org/packages/myst-parser