myst-parser


Namemyst-parser JSON
Version 0.15.1 PyPI version JSON
download
home_pagehttps://github.com/executablebooks/MyST-Parser
SummaryAn extended commonmark compliant parser, with bridges to docutils & sphinx.
upload_time2021-06-17 23:09:23
maintainer
docs_urlNone
authorChris Sewell
requires_python>=3.6
licenseMIT
keywords markdown lexer parser development docutils sphinx
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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,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



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/executablebooks/MyST-Parser",
    "name": "myst-parser",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "markdown,lexer,parser,development,docutils,sphinx",
    "author": "Chris Sewell",
    "author_email": "chrisj_sewell@hotmail.com",
    "download_url": "https://files.pythonhosted.org/packages/cc/ca/b60b369b77a6d533543170f492874d5421e9b5285e6d51796e71061047c8/myst-parser-0.15.1.tar.gz",
    "platform": "",
    "description": "# MyST-Parser\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-parser\n```\n\nor\n\n```bash\npip install myst-parser\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,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-parser.svg\n[pypi-link]: https://pypi.org/project/myst-parser\n[conda-badge]: https://anaconda.org/conda-forge/myst-parser/badges/version.svg\n[conda-link]: https://anaconda.org/conda-forge/myst-parser\n[black-link]: https://github.com/ambv/black\n[install-badge]: https://img.shields.io/pypi/dw/myst-parser?label=pypi%20installs\n[install-link]: https://pypistats.org/packages/myst-parser\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "An extended commonmark compliant parser, with bridges to docutils & sphinx.",
    "version": "0.15.1",
    "split_keywords": [
        "markdown",
        "lexer",
        "parser",
        "development",
        "docutils",
        "sphinx"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "d409d6b1156c30a75aa0cc658cb3c84c",
                "sha256": "e8baa9959dac0bcf0f3ea5fc32a1a28792959471d8a8094e3ed5ee0de9733ade"
            },
            "downloads": -1,
            "filename": "myst_parser-0.15.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d409d6b1156c30a75aa0cc658cb3c84c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 44894,
            "upload_time": "2021-06-17T23:09:22",
            "upload_time_iso_8601": "2021-06-17T23:09:22.547536Z",
            "url": "https://files.pythonhosted.org/packages/1c/98/794637ebd2106cc2b6400a7c0ceebb7745b1c6b58bb709467362e1c780d0/myst_parser-0.15.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "75100de6c88044bded14ad71057b180e",
                "sha256": "7c3c78a36c4bc30ce6a67933ebd800a880c8d81f1688fad5c2ebd82cddbc1603"
            },
            "downloads": -1,
            "filename": "myst-parser-0.15.1.tar.gz",
            "has_sig": false,
            "md5_digest": "75100de6c88044bded14ad71057b180e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 47933,
            "upload_time": "2021-06-17T23:09:23",
            "upload_time_iso_8601": "2021-06-17T23:09:23.513548Z",
            "url": "https://files.pythonhosted.org/packages/cc/ca/b60b369b77a6d533543170f492874d5421e9b5285e6d51796e71061047c8/myst-parser-0.15.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-06-17 23:09:23",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "executablebooks",
    "github_project": "MyST-Parser",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "myst-parser"
}
        
Elapsed time: 0.31384s