https://github.com/executablebooks/mdformat-myst
Mdformat plugin for MyST compatibility
https://github.com/executablebooks/mdformat-myst
markdown markdown-it mdformat myst
Last synced: 28 days ago
JSON representation
Mdformat plugin for MyST compatibility
- Host: GitHub
- URL: https://github.com/executablebooks/mdformat-myst
- Owner: executablebooks
- License: mit
- Created: 2021-04-09T16:14:15.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-11-14T05:27:33.000Z (5 months ago)
- Last Synced: 2025-03-10T16:49:34.490Z (about 1 month ago)
- Topics: markdown, markdown-it, mdformat, myst
- Language: Python
- Homepage:
- Size: 81.1 KB
- Stars: 10
- Watchers: 2
- Forks: 3
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-myst - mdformat-myst
README
[![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
```
[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