┌─────────────────────────────────────┐
│ $ marklint check README.md │
│ ───────────────────── │
│ README.md:12 title too long (78 > 60) │
│ README.md:34 link text missing │
│ README.md:45 heading levels skip (# → ###) │
│ ───────────────────── │
│ ✘ 3 issues found │
└─────────────────────────────────────┘
↑ 截图:命令行运行效果
简介
MarkLint 是一个命令行 Markdown 格式检查工具。帮你检查 Markdown 文件的格式规范,确保文档风格统一。
支持在 CI 流程中自动运行,发现格式问题直接报错退出。
功能
标题检查
标题层级不能跳级
链接检查
空链接、重复链接文字
长度检查
标题 / 行长度限制
自定义规则
通过 .marklintrc 配置文件定制
使用方法
# 检查单个文件
marklint check README.md
# 检查整个目录
marklint check ./docs/
# CI 模式(有错误时退出码非零)
marklint check ./ --ci
更新日志
v0.2 2026.02.20
- 新增:自定义规则配置文件 .marklintrc
- 新增:--ci 模式,退出码规范
v0.1 2026.02.01