用途:把 markdownlint 接入开发流程,保证 Markdown 文档风格一致。主要能力:命令行检查与自动修复、Node.js 编程 API、CI/CD 集成、Git 钩子、编辑器实时反馈。
命令行:安装 npm install -g markdownlint-cli 或 npm install --save-dev markdownlint-cli;常用命令 markdownlint '/*.md'、markdownlint -c .markdownlint.json '/.md'、markdownlint '**/.md' --ignore node_modules、markdownlint -f '**/*.md' 自动修复、--json 输出、-q 仅退出码。
编程 API:require('markdownlint') 回调式;import { lint } from 'markdownlint/promise' 异步;import { lint } from 'markdownlint/sync' 同步;支持 strings 直接检查字符串、customRules 自定义规则、readConfigSync 读取配置;applyFix 与 applyFixes 可程序化修复。
CI/CD:提供 GitHub Actions、GitLab CI、CircleCI、Jenkins、Azure Pipelines 配置示例,也可用 DavidAnson/markdownlint-cli2-action。
钩子与编辑器:Husky、lint-staged、pre-commit 框架;VS Code 扩展、Vim/Neovim ALE、Sublime Text、Atom 集成。
适用场景:新项目初始化、文档质量自动化、统一团队规范、自动修复脚本。限制:需 Node.js 环境;自动修复前应先提交版本;需正确配置忽略规则与 glob,避免检查 node_modules 或构建产物;具体版本与规则细节以官方资料为准。