如果你是一名前端工程师或是博客作者，你一定经常使用 Markdown 格式来写作。但是，你有没有想过，在书写 Markdown 格式的过程中，如何保证文档的可读性和一致性呢？针对这个问题，我们介绍一款 npm 包：@webacceleration/markdownlint-config-base，可以帮助你更好地书写 Markdown 文档。
1. 什么是 @webacceleration/markdownlint-config-base？
@webacceleration/markdownlint-config-base 是一个在 markdownlint 基础上封装的 Markdown 风格规范配置包。该包支持大部分的语法规则，并且具备较强的可自定义性，满足不同人群的需求。
2. 如何安装 @webacceleration/markdownlint-config-base？
你可以通过 npm 来安装 @webacceleration/markdownlint-config-base 包，执行以下命令即可：
npm install @webacceleration/markdownlint-config-base --save-dev
3. 如何使用 @webacceleration/markdownlint-config-base？
在项目中安装 @webacceleration/markdownlint-config-base 包后，你可以在对应的 markdown 文件中通过配置 markdownlint 的配置文件来启用规则。具体用法如下：
3.1 在项目根目录下创建 .markdownlintrc.json 配置文件
在项目的根目录下，创建名为 .markdownlintrc.json 的规则配置文件，按照以下内容进行配置：
{
"extends": "@webacceleration/markdownlint-config-base",
"rules": {
// 此处可以自定义规则
}
}配置文件包含两个字段：
- extends：指定继承的规则集，此处填写 @webacceleration/markdownlint-config-base 即可
- rules：可以根据自己的需求进行自定义
3.2 在 markdown 文件中加入规则
在 markdown 文件中，你可以增加规则来保证文档的可读性和一致性。比如，你可以在头部增加一行注释，指定该文件的编码格式
<!-- markdownlint-disable MD033 --> # 重要事项
注释的内容是 markdownlint-disable，后面跟着需要禁用的规则的编码。在以上例子中，MD033 表示禁用标题下方空行的规则。
又如，你可以在表格中增加特定的规则，以保证表格的排版效果：
| 表头 | 表头 | 表头 | | ---: | :--- | :---: | | 第一行 | 第一行 | 第一行 | | 第二行 | 第二行 | 第二行 |
表格的规则设置如下：
- 第一列居右对齐（---:）
- 第二列居左对齐（:---）
- 第三列居中对齐（:---:）
4. 总结
通过本文的介绍，你已经了解了如何使用 @webacceleration/markdownlint-config-base 包来设置 Markdown 文档的书写规范。使用规范的 Markdown 文档不仅便于编辑阅读，更有助于提升文档的美感和阅读体验。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600672513660cf7123b362c3