[![Build Status][ci-badge]][ci-link]
[![codecov.io][codecov-badge]][codecov-link]
[![PyPI version][pypi-badge]][pypi-link]
# mdformat-myst
> Mdformat plugin for MyST compatibility
## Description
[Mdformat](https://github.com/executablebooks/mdformat) is a formatter for
[CommonMark](https://spec.commonmark.org/current/)
compliant Markdown.
Mdformat-myst is an mdformat plugin that changes the target specification to
[MyST](https://myst-parser.readthedocs.io/en/latest/using/syntax.html),
making the tool able to format the following syntax extensions:
- [tables](https://github.github.com/gfm/#tables-extension-)
- [directives](https://myst-parser.readthedocs.io/en/latest/using/syntax.html#syntax-directives)
- [roles](https://myst-parser.readthedocs.io/en/latest/using/syntax.html#syntax-roles)
- [inline and block "dollar math"](https://myst-parser.readthedocs.io/en/latest/using/syntax.html#math-shortcuts)
- [comments](https://myst-parser.readthedocs.io/en/latest/using/syntax.html#syntax-comments)
- [block breaks](https://myst-parser.readthedocs.io/en/latest/using/syntax.html#syntax-blockbreaks)
- [targets](https://myst-parser.readthedocs.io/en/latest/using/syntax.html#syntax-targets)
- [front matter](https://myst-parser.readthedocs.io/en/latest/using/syntax.html#extended-block-tokens)
- [footnotes](https://pandoc.org/MANUAL.html#footnotes)
## Install
```sh
pip install mdformat-myst
```
## Usage
```sh
mdformat <filename>
```
[ci-badge]: https://github.com/executablebooks/mdformat-myst/workflows/Tests/badge.svg?branch=master
[ci-link]: https://github.com/executablebooks/mdformat-myst/actions?query=workflow%3ATest+branch%3Amaster+event%3Apush
[codecov-badge]: https://codecov.io/gh/executablebooks/mdformat-myst/branch/master/graph/badge.svg
[codecov-link]: https://codecov.io/gh/executablebooks/mdformat-myst
[pypi-badge]: https://img.shields.io/pypi/v/mdformat-myst.svg
[pypi-link]: https://pypi.org/project/mdformat-myst
Raw data
{
"_id": null,
"home_page": "https://github.com/hukkinj1/mdformat-myst",
"name": "mdformat_myst",
"maintainer": "Executable Book Project",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "executablebooks@gmail.com",
"keywords": "mdformat, markdown, formatter, gfm",
"author": "Taneli Hukkinen",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/10/e6/8299fdbc8fdb28830a599fb7de4c567ee802cbbfae65689dd01a7d232f67/mdformat_myst-0.2.1.tar.gz",
"platform": null,
"description": "[![Build Status][ci-badge]][ci-link]\n[![codecov.io][codecov-badge]][codecov-link]\n[![PyPI version][pypi-badge]][pypi-link]\n\n# mdformat-myst\n\n> Mdformat plugin for MyST compatibility\n\n## Description\n\n[Mdformat](https://github.com/executablebooks/mdformat) is a formatter for\n[CommonMark](https://spec.commonmark.org/current/)\ncompliant Markdown.\n\nMdformat-myst is an mdformat plugin that changes the target specification to\n[MyST](https://myst-parser.readthedocs.io/en/latest/using/syntax.html),\nmaking the tool able to format the following syntax extensions:\n\n- [tables](https://github.github.com/gfm/#tables-extension-)\n- [directives](https://myst-parser.readthedocs.io/en/latest/using/syntax.html#syntax-directives)\n- [roles](https://myst-parser.readthedocs.io/en/latest/using/syntax.html#syntax-roles)\n- [inline and block \"dollar math\"](https://myst-parser.readthedocs.io/en/latest/using/syntax.html#math-shortcuts)\n- [comments](https://myst-parser.readthedocs.io/en/latest/using/syntax.html#syntax-comments)\n- [block breaks](https://myst-parser.readthedocs.io/en/latest/using/syntax.html#syntax-blockbreaks)\n- [targets](https://myst-parser.readthedocs.io/en/latest/using/syntax.html#syntax-targets)\n- [front matter](https://myst-parser.readthedocs.io/en/latest/using/syntax.html#extended-block-tokens)\n- [footnotes](https://pandoc.org/MANUAL.html#footnotes)\n\n## Install\n\n```sh\npip install mdformat-myst\n```\n\n## Usage\n\n```sh\nmdformat <filename>\n```\n\n[ci-badge]: https://github.com/executablebooks/mdformat-myst/workflows/Tests/badge.svg?branch=master\n[ci-link]: https://github.com/executablebooks/mdformat-myst/actions?query=workflow%3ATest+branch%3Amaster+event%3Apush\n[codecov-badge]: https://codecov.io/gh/executablebooks/mdformat-myst/branch/master/graph/badge.svg\n[codecov-link]: https://codecov.io/gh/executablebooks/mdformat-myst\n[pypi-badge]: https://img.shields.io/pypi/v/mdformat-myst.svg\n[pypi-link]: https://pypi.org/project/mdformat-myst\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Mdformat plugin for MyST compatibility.",
"version": "0.2.1",
"project_urls": {
"Homepage": "https://github.com/hukkinj1/mdformat-myst"
},
"split_keywords": [
"mdformat",
" markdown",
" formatter",
" gfm"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "3ccb4b251b6cfbf26bdaba6f0955b107911601a86279f8d0067148b003a78b63",
"md5": "f28e3d8872033fe883a041bb520a4fc8",
"sha256": "ba338b063c664d75ede0eeda1b4f85dc4f4be5a2b678d44fa402035dee3b96b1"
},
"downloads": -1,
"filename": "mdformat_myst-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f28e3d8872033fe883a041bb520a4fc8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6591,
"upload_time": "2024-11-14T00:48:14",
"upload_time_iso_8601": "2024-11-14T00:48:14.301215Z",
"url": "https://files.pythonhosted.org/packages/3c/cb/4b251b6cfbf26bdaba6f0955b107911601a86279f8d0067148b003a78b63/mdformat_myst-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "10e68299fdbc8fdb28830a599fb7de4c567ee802cbbfae65689dd01a7d232f67",
"md5": "cb830b2492ae5c1989d134b0830e9443",
"sha256": "b45ebbf73c78c42bd6059c6ed910170488477a6285870561df7ac9d782978784"
},
"downloads": -1,
"filename": "mdformat_myst-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "cb830b2492ae5c1989d134b0830e9443",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 29471,
"upload_time": "2024-11-14T00:48:15",
"upload_time_iso_8601": "2024-11-14T00:48:15.246703Z",
"url": "https://files.pythonhosted.org/packages/10/e6/8299fdbc8fdb28830a599fb7de4c567ee802cbbfae65689dd01a7d232f67/mdformat_myst-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-14 00:48:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hukkinj1",
"github_project": "mdformat-myst",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "mdformat_myst"
}
JSON
