首页/开发/代码质量与评审速查/markdownlint:Markdown 规范检查
规范与静态检查65 条

markdownlint:Markdown 规范检查

markdownlint 检查 Markdown 结构与风格:MD013(行宽)、MD041(首行须为一级标题)、文件末尾换行等,适合文档仓库批量执行。

典型规则MD013 行宽 / MD041 首行一级标题 / 末尾换行
工具markdownlint-cli2 等包装

用法

用法
npx markdownlint-cli2 "docs/**/*.md"
markdownlint docs/
统一文档结构:标题层级不跳级、代码块标注语言,读者与工具都受益。

易错点

  • 行宽规则与表格冲突:对表格单独放宽而不是整体关闭
  • 全部规则关掉只查错别字:标题跳级等结构问题长期存在

数据来源与参考

  • markdownlint 官方仓库(github.com/DavidAnson/markdownlint)
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌