工程开发
markdownlint avatar

markdownlint

使用 markdownlint-cli2 对 Markdown 文件进行检查、格式化与验证,并结合项目特定规则以确保文档质量与一致性。

简介

markdownlint 技能为维护 Markdown 文件的完整性、风格与语法提供自动化专业知识。本技能专为开发人员、技术撰稿人及研究人员设计,旨在通过 markdownlint-cli2 工具确保仓库内的一致性。此技能可自动检测常见语法错误、强制执行特定风格准则,并提供即时反馈或自动修正功能,以简化文档编写流程。

  • 针对可配置规则检查 Markdown 文件,以识别结构性问题、损坏的语法与格式不一致之处。

  • 自动修正常见问题,减少维护代码时的手动编辑开销。

  • 强制执行项目特定规则,例如代码块强制要求语言标识符 (MD040) 以及标准列表缩排 (MD007)。

  • 支持通配符 (glob patterns) 以处理大型文件集,包括递归目录处理与自定义排除项目。

  • 与 CI/CD 管线集成,确保所有提交的 Markdown 内容在合并前均符合既定的质量基准。

  • 支持标准输入 (stdin) 以及如 .markdownlint.yaml 等自定义配置文件,可根据特定项目需求调整检查标准。

  • 本技能严格遵循 .markdownlint.yaml 中定义的项目设置;在进行变更前,请务必确认项目特定规则,例如是否允许内嵌 HTML (MD033) 或是否禁用行长度限制 (MD013)。

  • 使用 --fix 标志进行大量风格违规修复,但在操作后请审查变更以确保保留预期的格式。

  • 请务必为代码块指定语言 (例如 python, bash, json) 以满足 MD040 的要求。

  • 使用 # 字符进行文件排除模式 (例如 #node_modules),以确保 Windows 与 Unix 环境间的跨平台兼容性。

  • 此工具在处理标准 Markdown 文件时极为高效,建议结合如 Vale 等其他文档工具进行文法与风格检查。

仓库统计

Star 数
3
Fork 数
2
Open Issue 数
7
主要语言
R
默认分支
main
同步状态
空闲
最近同步时间
2026年5月3日 19:40
在 GitHub 查看