mdformat-gfm
Mdformat plugin for GitHub Flavored Markdown compatibility
Decision gist · record as of 2026-08-14
Yes, if you format GFM markdown regularly. The package is actively maintained, has no known vulnerabilities, installs cleanly, and is MIT-licensed. It's a straightforward plugin for mdformat that adds necessary GFM support without friction. Install it if your workflow involves GitHub markdown; skip it if you only use CommonMark.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.10 or later.
- Low install friction with a pure-Python wheel.
- Maintenance is active with a recent release and ongoing commits; the package is in the top 5000 by downloads.
License · maintenance · safety
MIT (permissive) — MIT license permits commercial and private use with minimal restrictions, making it safe for most projects.
last release 2025-10-16 (302 days) · last repo commit 2026-08-10 · 25 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 1,422,590 downloads/mo, #3,922 on PyPI
Alternatives
Verify before relying
pipx install mdformat
pipx inject mdformat mdformat-gfm
mdformat --gfm file.md- Whether compact_tables option works correctly with all GFM table edge cases.
- Performance characteristics when formatting very large markdown files with complex tables.
What it is and what it does
Mdformat-gfm is a plugin for mdformat that shifts the formatting target from CommonMark to GitHub Flavored Markdown. It enables mdformat to understand and preserve GFM-specific syntax extensions: tables, task list items (checkboxes), strikethroughs, autolinks, and raw HTML handling rules. The plugin is installed via pipx injection into an existing mdformat installation and integrates as a drop-in formatter for GFM-heavy projects.
The package depends on mdformat as its core formatter, along with markdown-it-py and mdit-py-plugins for parsing, and wcwidth for text measurement. It adds a `--compact-tables` CLI flag to strip alignment spaces from tables, and can be configured via `.mdformat.toml` for persistent settings. This is useful for teams using GitHub as their primary documentation platform or for projects that rely on GFM syntax in their markdown workflows.
Use it for
- Format markdown documentation in GitHub repositories that use tables and task lists.
- Enforce consistent GFM syntax style across a project's README and wiki files.
- Automatically compact GFM tables to reduce whitespace in version-controlled markdown.
- Integrate GFM formatting into CI/CD pipelines for documentation linting.
- Convert and reformat CommonMark documents to GitHub Flavored Markdown syntax.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you format GFM markdown regularly.
The package is actively maintained, has no known vulnerabilities, installs cleanly, and is MIT-licensed. It's a straightforward plugin for mdformat that adds necessary GFM support without friction. Install it if your workflow involves GitHub markdown; skip it if you only use CommonMark.
Install
mdformat-gfm on PyPI
Before you install
Low install friction with a pure-Python wheel. Maintenance is active with a recent release and ongoing commits; the package is in the top 5000 by downloads.
Requires Python 3.10 or later.
License in practice
MIT license permits commercial and private use with minimal restrictions, making it safe for most projects.
Quickstart
pipx install mdformat
pipx inject mdformat mdformat-gfm
mdformat --gfm file.mdVerify before relying
- Whether compact_tables option works correctly with all GFM table edge cases.
- Performance characteristics when formatting very large markdown files with complex tables.
Package facts
| License | MIT permissive |
| Python support | Supports the current Python release >=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 4 packagesmdformatmarkdown-it-pymdit-py-pluginswcwidth |
| Maintenance | Actively maintained 302 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 1,422,590 / month, #3,922 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Topic :: DocumentationTopic :: Text Processing :: Markup |
Evidence: mdformat_gfm-1.0.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “markdown formatter gfm”
- mdformat-gfmMdformat-gfm extends mdformat to format GitHub Flavored Markdown,…
- mdformat-gfm-alertsA plugin for mdformat that formats GitHub Markdown Alerts…
- mdformat_mystmdformat-myst is an mdformat plugin that extends Markdown formatting…
Give your agent the search over MCP, or paste the wish link into any chat.
More Markup packages
PyYAML parses and emits YAML 1.1 data format, enabling serialization and deserialization of configuration files and Python objects to and from human-readable YAML text.
A Python markdown parser that converts markdown to HTML following the CommonMark specification, with support for plugins and custom syntax rules.
Install it if you need reliable markdown-to-HTML conversion.
Beautiful Soup parses HTML and XML documents into a navigable tree, providing Pythonic methods to search, iterate, and modify the parsed content.
Install it if you need to parse or extract data from markup documents.
et_xmlfile writes large XML files with minimal memory overhead by serializing elements to disk as they are created, rather than holding the entire tree in memory.
Install it if incremental XML writing fits your use case; skip it if your XML documents are small or you already use lxml.
Parses and edits TOML files while preserving formatting, comments, and structure, then serializes them back with layout intact.
Install it if you're building tools that touch TOML files and user readability of the source matters.
Parses Python docstrings in ReST, Google, Numpydoc, and Epydoc formats, extracting structured information like descriptions, parameters, return types, and exceptions.
Install it if you need to programmatically read and extract structured data from Python docstrings.
See also mdformat · mdformat-gfm-alerts · py-gfm · mdformat_myst · mdformat_tables · mdformat-ruff · multimark · mdformat-toc · cmarkgfm · gdtoolkit