mdformat-gfm
Mdformat plugin for GitHub Flavored Markdown compatibility
Description
Mdformat is a formatter for CommonMark compliant Markdown.
Mdformat-gfm is an mdformat plugin that changes the target specification to GitHub Flavored Markdown (GFM), making the tool able to format the following syntax extensions:
- tables
- task list items
- strikethroughs
- autolinks
- disallowed raw HTML (note that no changes are required from a formatter to support this extension)
Install
pipx install mdformat
pipx inject mdformat mdformat-gfm
Usage
mdformat <filename>
Configuration
Mdformat-gfm distribution includes two plugins identified as gfm and tables.
The gfm plugin adds support for all GFM syntax (including tables).
Enabling tables only adds tables support.
Mdformat-gfm adds a --compact-tables CLI option and a corresponding compact_tables TOML boolean.
Turning this on will strip extra spaces from GFM tables that are otherwise used to align table columns.
To use the option on the command line, do
mdformat --compact-tables <filename>
Alternatively add the following in a .mdformat.toml configuration file
[plugin.tables]
compact_tables = true
1 maintainer
Metadata
1 maintainer
Release files for mdformat-gfm 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mdformat_gfm-1.0.0.tar.gz | 10.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mdformat_gfm-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 21.1 kB
Release files / mdformat_gfm-1.0.0.tar.gz
| Download URL | mdformat_gfm-1.0.0.tar.gz |
|---|---|
| Size | 10.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d1d49a409a6acb774ce7635c72d69178df7dce1dc8cdd10e19f78e8e57b72623
|
|
BLAKE2b-256 checksum How to use checksums |
566fa626ebb142a290474401b67e2d61e73ce096bf7798ee22dfe6270f924b3f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.7
|
Release files / mdformat_gfm-1.0.0-py3-none-any.whl
| Download URL | mdformat_gfm-1.0.0-py3-none-any.whl |
|---|---|
| Size | 11.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7305a50efd2a140d7c83505b58e3ac5df2b09e293f9bbe72f6c7bee8c678b005
|
|
BLAKE2b-256 checksum How to use checksums |
e6186bc2189b744dd383cad03764f41f30352b1278d2205096f77a29c0b327ad
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.7
|
