在 Markdown 中,无序列表标记通常是用 *
、-
或 +
表示。不过有时候我们可能需要统一风格,比如规定使用 -
。在这种情况下,可以使用 npm 包 remark-lint-unordered-list-marker-style
。
安装
要使用 remark-lint-unordered-list-marker-style
,需要先安装 Node.js 和 npm。然后,可以通过以下命令安装:
npm install -D remark-cli remark-lint remark-lint-unordered-list-marker-style
注意:这里使用了 -D
参数,表示将该包安装为开发依赖。
使用
安装完成后,可以在项目根目录下创建一个 .remarkrc.js
配置文件,并添加以下内容:
module.exports = { plugins: [ "remark-preset-lint-recommended", ["remark-lint-unordered-list-marker-style", "-"] ] };
这里使用了 remark-preset-lint-recommended 插件来启用 remark 推荐的语法检查规则。
第二个插件 remark-lint-unordered-list-marker-style
需要传递一个参数,用于指定无序列表标记的风格。上面的例子中指定为 -
,意味着只允许使用 -
作为无序列表标记。
保存配置文件后,在命令行中执行以下命令即可进行语法检查:
npx remark ./*.md
这里假设 Markdown 文件都在当前目录下。如果需要检查其他目录下的文件,可以将 ./
替换为相应的路径。
示例
假设我们有一个 Markdown 文件 example.md
,内容如下:
# Example - Item 1 - Item 2 + Item 3
其中第三个列表项使用了 +
标记,不符合规定。
执行上述命令后,会得到以下输出:
example.md 4:3-4:12 warning Incorrect unordered list item marker style remark-lint-unordered-list-marker-style
这表示在第四行第三列到第四列第十二列之间,存在一个使用了错误的无序列表标记风格的警告。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/45292