# MyST-Parser
Note: myst-docutils is identical to myst-parser, but without installation requirements on sphinx
[![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-docutils
```
or
```bash
pip install myst-docutils
```
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-docutils.svg
[pypi-link]: https://pypi.org/project/myst-docutils
[conda-badge]: https://anaconda.org/conda-forge/myst-docutils/badges/version.svg
[conda-link]: https://anaconda.org/conda-forge/myst-docutils
[black-link]: https://github.com/ambv/black
[install-badge]: https://img.shields.io/pypi/dw/myst-docutils?label=pypi%20installs
[install-link]: https://pypistats.org/packages/myst-docutils
Raw data
{
"_id": null,
"home_page": null,
"name": "myst-docutils",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "markdown, lexer, parser, development, docutils, sphinx",
"author": null,
"author_email": "Chris Sewell <chrisj_sewell@hotmail.com>",
"download_url": "https://files.pythonhosted.org/packages/66/13/b81a3c36c0709e1c8960bd39a4cdb5a3b6295ee147855d1283880dd1299f/myst_docutils-3.0.1.tar.gz",
"platform": null,
"description": "# MyST-Parser\n\nNote: myst-docutils is identical to myst-parser, but without installation requirements on sphinx\n\n[![Github-CI][github-ci]][github-link]\n[![Coverage Status][codecov-badge]][codecov-link]\n[![Documentation Status][rtd-badge]][rtd-link]\n[![Code style: black][black-badge]][black-link]\n[![PyPI][pypi-badge]][pypi-link]\n[![Conda][conda-badge]][conda-link]\n[![PyPI - Downloads][install-badge]][install-link]\n\n\n**MyST is a rich and extensible flavor of Markdown meant for technical documentation and publishing**.\n\nMyST is a flavor of markdown that is designed for simplicity, flexibility, and extensibility.\nThis 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.\nIt 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.\n\n[**See the MyST Parser documentation for more information**](https://myst-parser.readthedocs.io/en/latest/).\n\n## Installation\n\nTo install the MyST parser, run the following in a\n[Conda environment](https://docs.conda.io) (recommended):\n\n```bash\nconda install -c conda-forge myst-docutils\n```\n\nor\n\n```bash\npip install myst-docutils\n```\n\nOr for package development:\n\n```bash\ngit clone https://github.com/executablebooks/MyST-Parser\ncd MyST-Parser\ngit checkout master\npip install -e .[code_style,linkify,testing,rtd]\n```\n\nTo use the MyST parser in Sphinx, simply add: `extensions = [\"myst_parser\"]` to your `conf.py`.\n\n## Contributing\n\nWe welcome all contributions!\nSee the [Contributing Guide](https://myst-parser.readthedocs.io/en/latest/develop/index.html) for more details.\n\n[github-ci]: https://github.com/executablebooks/MyST-Parser/workflows/continuous-integration/badge.svg?branch=master\n[github-link]: https://github.com/executablebooks/MyST-Parser\n[codecov-badge]: https://codecov.io/gh/executablebooks/MyST-Parser/branch/master/graph/badge.svg\n[codecov-link]: https://codecov.io/gh/executablebooks/MyST-Parser\n[rtd-badge]: https://readthedocs.org/projects/myst-parser/badge/?version=latest\n[rtd-link]: https://myst-parser.readthedocs.io/en/latest/?badge=latest\n[black-badge]: https://img.shields.io/badge/code%20style-black-000000.svg\n[pypi-badge]: https://img.shields.io/pypi/v/myst-docutils.svg\n[pypi-link]: https://pypi.org/project/myst-docutils\n[conda-badge]: https://anaconda.org/conda-forge/myst-docutils/badges/version.svg\n[conda-link]: https://anaconda.org/conda-forge/myst-docutils\n[black-link]: https://github.com/ambv/black\n[install-badge]: https://img.shields.io/pypi/dw/myst-docutils?label=pypi%20installs\n[install-link]: https://pypistats.org/packages/myst-docutils\n",
"bugtrack_url": null,
"license": null,
"summary": "An extended [CommonMark](https://spec.commonmark.org/) compliant parser,",
"version": "3.0.1",
"project_urls": {
"Documentation": "https://myst-parser.readthedocs.io",
"Homepage": "https://github.com/executablebooks/MyST-Parser"
},
"split_keywords": [
"markdown",
" lexer",
" parser",
" development",
" docutils",
" sphinx"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d4b160f16eb31a52d123118325c49400ce1f2a2a42d36ace8e7ec7543a7e8c73",
"md5": "cd176a144d51b4a5291dec7bd4ea23f8",
"sha256": "b7db7ff8d10cd79c89f639134a2cc13f42b6ec22036785763cf11036f7dc1804"
},
"downloads": -1,
"filename": "myst_docutils-3.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cd176a144d51b4a5291dec7bd4ea23f8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 83239,
"upload_time": "2024-04-28T20:22:59",
"upload_time_iso_8601": "2024-04-28T20:22:59.060509Z",
"url": "https://files.pythonhosted.org/packages/d4/b1/60f16eb31a52d123118325c49400ce1f2a2a42d36ace8e7ec7543a7e8c73/myst_docutils-3.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "6613b81a3c36c0709e1c8960bd39a4cdb5a3b6295ee147855d1283880dd1299f",
"md5": "7248d8f45bc08bf79ea500f6e59c4363",
"sha256": "6a542f1743963630dc934db6391275365e2dd638333192846c9c4f1ecae605c2"
},
"downloads": -1,
"filename": "myst_docutils-3.0.1.tar.gz",
"has_sig": false,
"md5_digest": "7248d8f45bc08bf79ea500f6e59c4363",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 92510,
"upload_time": "2024-04-28T20:23:01",
"upload_time_iso_8601": "2024-04-28T20:23:01.433183Z",
"url": "https://files.pythonhosted.org/packages/66/13/b81a3c36c0709e1c8960bd39a4cdb5a3b6295ee147855d1283880dd1299f/myst_docutils-3.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-28 20:23:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "executablebooks",
"github_project": "MyST-Parser",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "myst-docutils"
}
JSON
