npm 包 markdownlint 使用教程

在编写 Markdown 文档时，为了保证文档的可读性和一致性，我们需要对文档进行规范化处理。这时候，一个非常有用的工具就是 markdownlint。

什么是 markdownlint

markdownlint 是一个基于 Node.js 的命令行工具，可以检查 Markdown 文件中的语法错误和格式问题，并给出相应的提示和建议。

如何安装 markdownlint

在使用 markdownlint 之前，需要先安装它：

npm install -g markdownlint-cli

这条命令会全局安装 markdownlint-cli，也可以使用本地安装方式。

如何配置 markdownlint

运行以下命令可以生成一个默认的配置文件 .markdownlint.json：

markdownlint --init

通过修改 .markdownlint.json 文件中的规则，可以自定义 markdownlint 的检查内容和提示等级。

例如，以下是一个简单的 .markdownlint.json 配置文件：

{
  "default": true,
  "MD001": false,
  "MD013": false
}

其中，"default": true 表示使用默认规则，"MD001": false 表示不检查标题是否包含多个空格，"MD013": false 表示不检查代码块前后的空行数量。

更多规则配置可以参考 markdownlint 官方文档。

如何使用 markdownlint

运行以下命令，可以对指定的 Markdown 文件进行检查：

markdownlint example.md

markdownlint 还支持使用管道方式读取文件内容，例如：

cat example.md | markdownlint

如果需要忽略某些规则或者某些文件，可以在命令中使用 --ignore 参数：

markdownlint --ignore example.md,ignored.md

如何集成 markdownlint 到编辑器中

为了方便地在编辑器中使用 markdownlint，我们可以将其集成到编辑器的插件中。以下以 VS Code 为例：

1. 安装 markdownlint 插件；
2. 在 VS Code 的设置中，搜索 markdownlint，找到 Markdownlint: Config File 字段，并设置为我们自定义的 .markdownlint.json 配置文件；
3. 保存文档时即可自动进行 markdownlint 检查。

总结

通过本文，我们学习了如何安装、配置和使用 markdownlint，并且掌握了如何将其集成到编辑器中，以提高 Markdown 文档的质量和可读性。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/51645