在前端开发中，markdown 是一种非常常用的文本格式。为了提高 markdown 的规范性和可读性，我们需要使用一些工具来进行语法检查和格式化。其中，remark-preset-lint-recommended 是一个常用的 npm 包，它提供了一套针对 markdown 文件的约定规则和语法检查。
安装
使用 npm 进行安装：
npm install -D remark-cli remark-preset-lint-recommended
配置
在项目根目录下新建一个 .remarkrc.json 文件，并添加以下配置：
{
"plugins": [
"preset-lint-recommended"
]
}使用
命令行使用
可以使用命令行工具来检查 markdown 文件的语法：
npx remark --frail --rc-path .remarkrc.json README.md
选项说明：
--frail表示如果存在任何错误，则会退出并输出错误信息。--rc-path表示使用指定的配置文件。默认情况下，remark 会使用当前工作目录下的.remarkrc或者.remarkrc.json文件。
在 JavaScript 中使用
也可以在 JavaScript 代码中直接调用 remark：
-- -------------------- ---- ------- ----- ------- - ------------------ ----- -------- - ----------------------- ----- ---------- - ----------------------------------------- ----- ------ - ------------------------- ----- --------- - --------- -------------- ---------------- -------------------- ----- -------- ----- ----- -- - ------------------------ -- ------ --
这里使用了 unified 进行处理，并且添加了 markdown 和 remark-preset-lint-recommended 插件。调用 process 方法可以对 markdown 文本进行语法检查和格式化。
示例代码
下面是一些示例代码，可以用来验证配置是否生效：
-- -------------------- ---- ------- - -- ------- - --- - - --- - ----- -- --- ------------------ --------
结果
如果一切配置正确，那么上述示例代码的输出应该如下所示：
README.md
3:1-3:7 warning Heading levels should only increase by one level at a time heading-increment
5:9-5:11 warning Remove 1 list item list-item-indent
6:9-6:11 warning Remove 1 list item list-item-indent
8:1-10:4 info `console.log('Hello World!')` code-block-style
⚠ 3 warnings and 1 info found.其中包含了三个警告信息和一个提示信息。警告信息提示出现了标题级别跳级、列表缩进不规范等问题；提示信息则指出代码块应该使用什么风格。根据这些信息，我们可以更快地找到并修复 markdown 文件中存在的问题。
总结
remark-preset-lint-recommended 是一个非常有用的 npm 包，它提供了一套针对 markdown 文件的语法检查和格式化规则。通过本文的介绍，读者可以学习到如何安装、配置和使用该包，并且了解了在实际开发中如何应用它来提高 markdown 文件的质量。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/43006