Markdown 文件的检查、自动修复——目录、失效链接、YAML frontmatter 验证与格式化。零依赖（仅 Python 标准库）。
Markdown Linter & Formatter.
功能概述
Markdown Linter & Formatter.是一项面向实际任务的技能，主要用于Lint 和自动格式 Markdown: 后继白空格,前端物验证, TOC 生成, 外部链接检查.；Keywords: markdown, lint,格式, toc, cli, docs。
核心要点
- 它将相关步骤、工具调用和结果整理方式集中到统一流程中，帮助使用者更快完成目标并减少重复操作。
- 使用时应结合输入条件选择合适的执行方式，核对必要参数、依赖环境与输出内容，并按原始要求处理异常情况。
- 从功能定位来看，该技能强调把分散的操作要求整理成清晰、可复用的处理流程，使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。
使用与执行
实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数，再依据技能说明逐步执行；若输入条件不完整，应先补齐信息或采用保守配置，避免因错误假设导致结果偏离需求。执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期，并对异常提示、缺失字段和边界情况进行处理；
结果检查与注意事项
涉及批量任务时，还应保存进度，避免中断后重复操作。该技能适合用于一次性任务，也可以接入自动化工作流，与其他技能或上层代理配合完成更完整的业务链路；在组合使用时，应明确每一步的输入输出关系，并避免不同步骤之间出现参数冲突。
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 子命令帮助
使用场景
- 检查 Markdown 文件
- 自动格式化 / 标准化
- 校验 frontmatter
- 生成目录（TOC）
- 检查外部链接
为何选择本工具而非其他方案
| 替代方案 | 本工具的优势 |
|---|---|
| markdownlint | 额外支持 TOC 生成与 frontmatter 校验。 |
| 手动维护 TOC | 仅需一条命令即可完成。 |
| 链接失效问题 | 内置外部链接检查器。 |
常见问题（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
热门AI工具
相关专题
本专题聚焦Go-Zero的API开发，拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则，说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式，并给出网关聚合与接口测试的实践建议。
0
2026.11.12
本专题围绕Go-Zero的安装与工具链配置展开，讲清Go版本要求、goctl安装方式、代理镜像、protoc依赖与环境变量设置，说明多版本共存、升级回退与CI流水线安装的做法，并整理安装阶段的常见报错与验证步骤。
0
2026.11.12
本专题整理Go-Zero的入门知识，从框架定位、环境准备到跑通第一个API服务，讲清目录分层、配置加载、日志与中间件的基本用法，并对比Gin、Kratos的差异，帮助Go开发者建立整体认知，判断它是否适合当前项目。
0
2026.11.12
本专题从实际API接口调试场景出发，讲解Postman身份认证的完整配置流程，包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查，帮助用户正确完成接口授权与访问验证。
0
2026.11.06
围绕Postman HTTP请求头配置展开，讲解Headers选项的具体使用方式，包括Key和Value参数填写、请求头信息添加、常见Header字段设置及请求头修改方法，帮助用户解决接口调试过程中遇到的请求头配置问题。
0
2026.11.06
详细介绍Postman接口请求的创建与发送方法，涵盖GET和POST请求、URL配置、请求参数、Headers请求头、Body请求体设置以及响应结果查看，帮助用户掌握Postman接口请求的完整操作流程。
0
2026.11.06
DBeaver数据导入专题，整理Excel、CSV、SQL、TXT等常见文件的数据导入方法，涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作，帮助用户将本地文件中的数据写入数据库，并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。
0
2026.11.05
DBeaver安全防护专题，围绕数据库连接安全、账号密码保护和访问权限管理展开，整理SSL/TLS加密连接、SSH隧道、数据库凭据保存及证书验证等配置方法，同时介绍敏感信息保护、远程连接风险和高权限账号使用等注意事项，帮助用户提高数据库日常管理的安全性。
0
2026.11.05
本专题聚焦DBeaver数据库连接配置与管理，覆盖从新建连接、选择数据库类型到填写连接参数和验证连接的完整流程。针对MySQL、PostgreSQL、SQL Server等常见数据库，整理相应的连接设置方法，并提供驱动缺失、认证失败和连接异常等问题的排查方向。
0
2026.11.04
热门下载
相关下载
精品课程
共6课时 | 12.1万人学习
共79课时 | 161.8万人学习
共6课时 | 54.7万人学习
最新文章
