mdformat-gfm-alerts
Format 'GitHub Markdown Alerts,' which use blockquotes to render admonitions
Decision gist · record as of 2026-08-14
Yes, if you use mdformat and work with GitHub Markdown Alerts in your documentation. The plugin has low install friction, active maintenance, permissive licensing, no known vulnerabilities, and integrates seamlessly into mdformat's workflow. Install it if you need consistent alert formatting; skip it if you don't use GFM alerts.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python >=3.10.0
- Low install friction; pure Python wheel with only two runtime dependencies (mdformat and mdit-py-plugins).
- Active maintenance with a recent release 19 days ago.
License · maintenance · safety
MIT (permissive) — MIT license (permissive); you can use, modify, and distribute this package freely with minimal restrictions.
last release 2026-07-26 (19 days) · last repo commit 2026-07-27 · 9 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 169,395 downloads/mo, #10,418 on PyPI
Alternatives
Verify before relying
# Install alongside mdformat
pip install mdformat mdformat-gfm-alerts
# Format markdown files (plugin auto-recognized)
mdformat file.md
# Or import the plugin:
from mdformat_gfm_alerts.mdit_plugins import gfm_alerts_plugin- Whether the plugin handles edge cases beyond the five canonical GitHub alert types
- Performance characteristics when formatting large markdown files with many alerts
- Full scope of HTML rendering capabilities and output format details
What it is and what it does
mdformat-gfm-alerts is a plugin that extends mdformat to recognize and format GitHub Flavored Markdown (GFM) Alerts—a GitHub-native syntax for rendering admonitions using blockquotes with alert markers like `[!NOTE]`, `[!TIP]`, `[!IMPORTANT]`, `[!WARNING]`, and `[!CAUTION]`. It ensures these alerts conform to GitHub's specification by normalizing their structure during markdown formatting.
The plugin works by integrating directly into mdformat's pipeline; once installed, it is automatically recognized and requires no additional configuration. By default, it follows strict GitHub behavior (folding custom titles into the alert body), but a `--custom-title` option allows preserving inline titles on the marker line for compatibility with other conventions like Hugo's alert syntax.
Use it for
- Standardize GitHub alert syntax across a documentation repository to match GitHub's rendering behavior
- Auto-format markdown files in CI/CD pipelines using mdformat with consistent alert structure
- Convert or normalize alert blocks when migrating markdown between GitHub and other platforms
- Enforce alert formatting rules in pre-commit hooks alongside other markdown linting
- Integrate alert formatting into mdformat workflows without manual configuration
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you use mdformat and work with GitHub Markdown Alerts in your documentation.
The plugin has low install friction, active maintenance, permissive licensing, no known vulnerabilities, and integrates seamlessly into mdformat's workflow. Install it if you need consistent alert formatting; skip it if you don't use GFM alerts.
Install
mdformat-gfm-alerts on PyPI
Before you install
Low install friction; pure Python wheel with only two runtime dependencies (mdformat and mdit-py-plugins). Active maintenance with a recent release 19 days ago.
Requires Python >=3.10.0
License in practice
MIT license (permissive); you can use, modify, and distribute this package freely with minimal restrictions.
Quickstart
# Install alongside mdformat
pip install mdformat mdformat-gfm-alerts
# Format markdown files (plugin auto-recognized)
mdformat file.md
# Or import the plugin:
from mdformat_gfm_alerts.mdit_plugins import gfm_alerts_pluginVerify before relying
- Whether the plugin handles edge cases beyond the five canonical GitHub alert types
- Performance characteristics when formatting large markdown files with many alerts
- Full scope of HTML rendering capabilities and output format details
Package facts
| License | MIT permissive |
| Python support | Supports the current Python release >=3.10.0 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 2 packagesmdformatmdit-py-plugins |
| Maintenance | Actively maintained 19 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 169,395 / month, #10,418 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Intended Audience :: DevelopersLicense :: OSI Approved :: MIT LicenseProgramming Language :: Python :: 3Topic :: Software Development :: Libraries :: Python Modules |
Evidence: mdformat_gfm_alerts-2.1.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 › “github markdown alerts formatting”
- mdformat-gfm-alertsA plugin for mdformat that formats GitHub Markdown Alerts…
- comrakRenders CommonMark and GitHub Flavored Markdown to HTML or normalized…
- mkdocs-github-admonitions-pluginA MkDocs plugin that converts GitHub-flavored admonitions (using `>…
Give your agent the search over MCP, or paste the wish link into any chat.
More Python Modules packages
Converts domain names between Unicode and ASCII-compatible encoding (Punycode) according to IDNA 2008 and Unicode Technical Standard 46, with security validation and broader script coverage than the standard library.
Install it if you work with internationalized domain names, need to validate domains, or use HTTP clients that depend on it transitively.
Setuptools is a Python build backend and package management tool that handles building, distributing, and installing Python packages, including support for C/C++ extension modules.
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.
Pydantic validates Python data structures against type hints, coercing and checking input at runtime to ensure it matches a declared schema.
Provides reusable metadata objects for use with PEP-593 `typing.Annotated` to express common constraints like bounds, collection sizes, and predicates on types.
Install it if you use or build libraries that need to express type constraints in a standardized, inspectable way—or if you want to annotate your own types with…
Provides runtime tools to inspect and introspect Python type annotations, enabling programmatic examination of type hints at execution time.
See also mdformat-gfm · mdformat-mkdocs · mdformat · mdformat_myst · mdformat-footnote · mdformat-black · mdformat-front-matters · markdown-callouts · mdformat-ruff · mkdocs-github-admonitions-plugin