markdownlint 错误修复工具 ​

markdownlint-cli2 适用于批量修改 markdownlint 低错问题，如空行、缩进等，大大提高文档开发效率，但是复杂问题仍需要手动修复。

安装与配置 ​

安装 Node.js + npm ​

进入 Node.js官网下载 Node.js，并按照提示完成安装。

分别执行如下两条命令，如果显示版本号，则说明安装成功。

node -v
npm -v

安装 markdownlint-cli2 ​

执行如下命令，安装 markdownlint-cli2。

npm install markdownlint-cli2 --global

如果遇到类似以下错误，可能权限问题导致的。

npm error code EACCES
npm error syscall mkdir
npm error path /usr/local/lib/node_modules/markdownlint-cli2
npm error errno -13

以管理员身份解决该问题：如果是 Mac 或 Linux 系统，可以在命令前加 sudo；如果是 Windows 系统，在命令提示符或者PowerShell中以管理员身份运行命令。

配置 markdownlint-cli2 ​

markdownlint-cli2支持指定检查项，配置文件默认名为.markdownlint.json。将配置文件与待检查的 markdown 文件放在同一文件夹（如果要检查多个文件，则放在其共同的最上级文件夹），markdownlint-cli2就会自动读取并执行。

./markdownlint.json 文件示例如下：

{
  "MD003":{"style":"atx"},
  "MD029":{"style":"ordered"},
  "MD004":false,
  "MD007":false,
  "MD009":false,
  "MD013":false,
  "MD014":false,
  "MD020":false,
  "MD021":false,
  "MD024":false,
  "MD025":false,
  "MD027":false,
  "MD033":false,
  "MD036":false,
  "MD042":false,
  "MD043":false,
  "MD044":false,
  "MD045":false,
  "MD046":false,
  "MD048":false,
  "MD049":false,
  "MD050":false,
  "MD051":false,
  "MD052":false,
  "MD053":false,
  "MD055":false,
  "MD056":false,
  "MD057":false
}

检查与修复 ​

检查 ​

执行如下命令，检查指定的 markdown 文件或文件夹。

markdownlint-cli2 "**/*.md"

其中，文件路径可以是一个或多个文件名，也可以是通配符，或是文件夹。注意当被检测的文件夹中包含非.md格式的文件时，可能出现错误，导致检测失败。

修正 ​

修正markdownlint的错误，可以使用--fix参数。将在源文件上直接修正错误语法，不创建备份。执行如下命令：

markdownlint-cli2 --fix "**/*.md"