Markdown Linter & Formatter

对 Markdown 进行静态检查与自动格式化：检测尾部空白字符、校验 frontmatter、生成目录（TOC）、检查外部链接。

关键词：markdown、lint、format、toc、cli、docs、python、open-source、agent、automation、MIT

属于 itsPremkumar Hermes / OpenClaw / Paperclip agent 栈的一部分 —— 31 个免费、MIT 许可、CI 测试通过、原生支持 agent 的工具。

功能概述

Markdown 偏移（如链接失效、缺失 TOC、frontmatter 错误）会损害文档质量与 SEO 效果。Markdown Linter & Formatter 正是为此而生：提供 Markdown 静态检查与自动格式化能力，涵盖尾部空白字符清理、frontmatter 校验、TOC 自动生成、外部链接验证等功能。

最适合：文档负责人、开源项目维护者，以及生成 Markdown 的 agent。

特性

• 检查单个 Markdown 文件
• 自动格式化 / 标准化
• 校验 frontmatter
• 生成目录（TOC）
• 检查外部链接

安装

# 要求 Python 3.8+；无需 pip install。
curl -O https://raw.githubusercontent.com/itsPremkumar/md-linter/main/md_linter.py
# 或将该文件复制到任意位置 —— 它是自包含的。

快速开始

python md_linter.py self-test     # 端到端验证功能是否正常
python md_linter.py check --help   # 查看 check 子命令帮助
python md_linter.py toc --help     # 查看 toc 子命令帮助
python md_linter.py links --help   # 查看 links 子命令帮助
python md_linter.py frontmatter --help   # 查看 frontmatter 子命令帮助
python md_linter.py format --help  # 查看 format 子命令帮助

使用场景

1. 检查 Markdown 文件
2. 自动格式化 / 标准化
3. 校验 frontmatter
4. 生成目录（TOC）
5. 检查外部链接

为何选择本工具而非其他方案

常见问题（SEO / AEO 优化）

Q：支持 TOC 吗？
A：支持 —— 可自动生成并插入目录（Table of Contents）。

Q：支持外部链接检查吗？
A：--check-external 参数可用于验证外部链接有效性。

Q：支持就地写入（覆盖原文件）吗？
A：--write 参数可实现就地格式化。

Q：是否支持离线使用？
A：外部链接检查需联网；其余 lint 功能完全离线运行。

地域 / 本地适用性

由 @itsPremkumar（印度钦奈）开发与维护，面向全球开发者提供服务。 个人与团队均可免费使用。文档为英文；工具输出内容与系统区域设置无关（locale-neutral）。

CI 集成

# .github/workflows/verify.yml
name: Verify
on: [push]
jobs:
  verify:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Self-test md-linter
        run: python md_linter.py self-test

支持方式

免费 + MIT-0 许可（自由使用、可修改、无需署名）。若本工具对您有帮助，欢迎赞助：

• GitHub Sponsors：https://github.com/sponsors/itsPremkumar
• Buy Me a Coffee：https://buymeacoffee.com/itsPremkumar

⭐ 欢迎在 GitHub 上 Star