用于 Markdown/CommonMark 文件的 Node.js 样式检查器和 lint 工具。
安装
bash
npm install markdownlint --save-dev
概况
Markdown标记语言被设计为易于阅读、编写和理解。它成功了——它的灵活性既是优点也是缺点。可能有多种样式,因此格式可能不一致。某些构造并非在所有解析器中都能很好地工作,应该避免。CommonMark 规范标准化了解析器,但没有标准化作者。
markdownlint是 Node.js 的静态分析工具,具有规则库来强制执行 Markdown 文件的标准和一致性。它受到 Mark Harrison 的 Ruby markdownlint 的启发 并 深受影响。初始规则、规则文档和测试用例直接来自该项目。
有关的
命令行
- Node.js 的markdownlint-cli 命令行界面(与预提交一起使用)
- Node.js 的markdownlint-cli2 命令行界面(与预提交一起使用)
GitHub
- markdownlint-cli2 的 GitHub 操作
- GitHub Super-Linter 操作
- markdownlint-cli 的 GitHub Actions 问题匹配器
编辑
- VS Code 的 vscode-markdownlint 扩展
- Sublime Text markdownlint for Sublime Text
- Vim/Neovim 的 coc-markdownlint 扩展
工具
- 用于 ESLint 分析器的 eslint-plugin-markdownlint
- 用于 Grunt 任务运行程序的 grunt-markdownlint
- Cake.Markdownlint 插件,用于 Cake 构建自动化系统
- MSBuild 的 Lombiq Node.js 扩展(.NET 构建)