使用 Homebrew, apt, Nix, pacman 安装 mdformat

项目链接

• 主页
• 仓库
• 上游文档
• 软件包管理器页面

命令和别名

• mdformat

项目历史

The project was published to PyPI in July 2020 as version 0.1.0 and is developed in the hukkin/mdformat GitHub repository. Its README describes the core pitch as enforcing a consistent Markdown style while preserving CommonMark-rendered output.

The changelog shows steady maturation of the 0.7 series: configuration in `.mdformat.toml` arrived in 0.7.10, plugin interfaces evolved in 0.7.19, and version 1.0.0 later removed older Python support, added markdown-it-py v4 support, and added CommonMark 0.31.2 support.

采用历史

mdformat's adoption is tied to Python packaging and automated formatting workflows. Its official docs show installation with pipx, Python API use, and use as a pre-commit hook by referencing the GitHub repository and pinning a revision.

The plugin docs document a broader ecosystem of mdformat-* packages for GitHub Flavored Markdown, MyST, front matter, table-of-contents generation, code-block formatting with Black, shfmt, gofmt, rustfmt, and related tools. The input facts list availability in Homebrew, Debian, Nix, and Arch-style packaging.

使用方式

Common CLI usage is `mdformat README.md CHANGELOG.md`, `mdformat .` for recursive formatting, `mdformat -` for standard input, and `mdformat --check` in CI. The tool also exposes a Python API through `mdformat.text()` and `mdformat.file()`.

Configuration is resolved from a TOML file named `.mdformat.toml`, searched upward from the formatted file or from the current working directory for standard input. Command-line arguments take precedence over configuration values.

为什么软件包爱好者会关心

mdformat is a useful package-history marker for the shift from Markdown rendering tools to Markdown style enforcement. It fills a similar cultural role for Markdown that Black filled for Python: fewer formatting arguments, more reproducible diffs.

Its plugin model matters to packagers because optional behavior is split across separately distributed Python packages. That keeps the core package small but makes environment composition important for users who need GFM, MyST, front matter, or code-block formatters.

时间线

• 2020: Version 0.1.0 published to PyPI.
• 2021: Version 0.7.10 added `.mdformat.toml` configuration.
• 2025: Version 1.0.0 published with Python support and CommonMark updates.
• 2026: Homebrew formula tracked stable version 1.0.0.

Related projects

• The README explicitly compares mdformat with Prettier for Markdown formatting and discusses CommonMark-focused behavior.
• The plugin ecosystem includes mdformat-gfm, mdformat-black, mdformat-toc, mdformat-myst, mdformat-frontmatter, and other official-doc-listed extensions.

来源

• https://github.com/hukkin/mdformat#readme
• https://mdformat.readthedocs.io/en/stable/users/changelog.html
• https://mdformat.readthedocs.io/en/stable/users/configuration_file.html
• https://mdformat.readthedocs.io/en/stable/users/installation_and_usage.html
• https://mdformat.readthedocs.io/en/stable/users/plugins.html
• https://pypi.org/project/mdformat/
• source_facts.package-manager