介绍
Markdown 是一种轻量级标记语言，被广泛用于编写文档、博客、README 等。Markdownlint 是一个用于检查 Markdown 文件风格和规范的工具。markdownlint-cli 是 markdownlint 的命令行接口版本，可以方便地对多个 Markdown 文件进行检查。
本文将介绍如何使用 markdownlint-cli 进行 Markdown 文件的规范检查。
安装
在使用 markdownlint-cli 前，需要安装 Node.js 并在终端中安装 markdownlint-cli。
npm install -g markdownlint-cli
安装完成后，在终端中输入以下命令，确认是否成功安装了 markdownlint-cli。
markdownlint --version
如果出现 markdownlint-cli 的版本号，则说明安装成功。
使用
markdownlint-cli 检查 Markdown 文件时，会根据预设的规则检查每个文件，并输出未通过规则检查的内容。
在终端中输入以下命令，即可对指定的 Markdown 文件进行检查。
markdownlint my-file.md
如果要同时检查多个 Markdown 文件，可以将它们的路径作为参数传递给 markdownlint-cli。例如：
markdownlint file1.md path/to/file2.md
或者，也可以使用通配符表示要检查的所有 Markdown 文件。例如：
markdownlint *.md
markdownlint-cli 默认使用 markdownlint 的规则集，可以通过在命令行中指定配置文件的路径来自定义规则集。例如：
markdownlint --config my-config.json my-file.md
更多的命令行选项和用法信息，可以查看 markdownlint-cli 的文档。
示例
下面是一个 Markdown 文件的示例内容：
-- -------------------- ---- -------
- ----- -----
------------- ---------------- ------
-- --
- ---
- -- -
- -- -
- ---
- ---
-- ---
----- ---------- -------
-------------
-------- ----------- -
------------------- -----------
-
---------------链接
这里有一个链接到 GitHub 的示例。
图片
这里有一个图片的示例：
运行以下命令，即可对上述 Markdown 文件进行检查。 ```bash markdownlint example.md
输出结果如下：
example.md:7: MD012/ul-indent: List item indent should be multiples of 4 example.md:10: MD031/blanks-around-fences: Fenced code blocks should be surrounded by blank lines example.md:19: MD013/line-length: Line length should be at most 80 characters (currently 87) example.md:22: MD031/blanks-around-fences: Fenced code blocks should be surrounded by blank lines example.md:28: MD010/hard-tabs: Hard tabs should not be used
其中，每一行都包含了一个错误的信息和相应的规则编号。例如，第 7 行的 MD012/ul-indent 意味着这个列表项的缩进不是 4 的倍数。
根据这些规则编号，可以查看 markdownlint 的文档，找到对应的规则解释，并修正 Markdown 文件中的错误。
总结
markdownlint-cli 是一个简单易用的 Markdown 规范检查工具，可以帮助我们在编写 Markdown 文件时保持良好的风格和格式。通过本文的介绍，您现在应该已经了解了如何安装和使用 markdownlint-cli，并且知道如何对 Markdown 文件进行规范检查
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/51644