用途:校验 Markdown 文件是否符合格式标准,帮助保持文档风格一致、差异可读并满足 POSIX 规范。
主要能力:检查 markdownlint-cli 是否安装,缺失时全局安装;按优先级探测项目配置(.markdownlint.json、.markdownlint.yaml、.markdownlintrc、package.json 的 markdownlint 字段),否则使用参考文件中的默认配置;校验文件的格式、结构与风格;可用 --fix 自动修复常见问题,并报告具体规则及修复建议。
使用方式:先检查环境 markdownlint --version 2>/dev/null;未安装则执行 npm install -g markdownlint-cli。安装失败需停止校验并给出补救步骤(sudo、修复 npm 权限、使用 nvm/volta/fnm 或安装 Node.js),不得静默跳过。随后探测配置并运行校验:markdownlint README.md CHANGELOG.md docs/,或自动修复:markdownlint --fix README.md CHANGELOG.md docs/。修复后需重新运行不带 --fix 的命令确认。
限制:部分问题如 MD001 heading-increment 无法自动修复,需手动处理;无项目配置时会创建临时默认配置。规则完整参考见 references/markdownlint-rules.md。具体价格、平台支持与效果资料暂未提供。