在编写 Markdown 文档时,有序列表是一种常见的排列方式。然而,在使用有序列表时经常会遇到需要修改数字开头或者字母开头等问题。这就需要了解一个 npm 包:remark-lint-ordered-list-marker-value
。
什么是 remark-lint-ordered-list-marker-value?
remark-lint-ordered-list-marker-value
是一个 remark 插件,用于检查和修复有序列表标记符号(marker)。
该插件可以检测并纠正以下问题:
- 列表项开始数字不是1
- 列表项开始字母不是a
- 列表项开始罗马数字不是i
安装和使用
要使用 remark-lint-ordered-list-marker-value
,需要先安装它以及 remark
和 remark-cli
:
--- ------- ------ ----------- ------------------------------------- ---------- --
接着,在 remark
的配置文件中添加该插件:
-- ------------ -------------- - - -------- - ---------------- ----------------------------------------- ------ -- ---- ------ -- --
现在,当运行 remark
检查 Markdown 文件时,remark-lint-ordered-list-marker-value
会自动检测和修复列表项的起始符号。
例如,在以下 Markdown 文件中,列表项的起始数字为3,使用了错误的标记符号:
-- --- -- --- -- ---
运行 remark
后,会输出以下结果:
---------- ------- ------- --------- ------- ---- ------ ----- ------------------------------------- ------- ------- --------- ------- ---- ------ ----- ------------------------------------- - - --------
可以看到,remark-lint-ordered-list-marker-value
提示了两个警告,并且自动更正了列表项的起始数字和标记符号。
高级使用
除了自动修复外,remark-lint-ordered-list-marker-value
还提供了其他选项,可以根据实际需求进行配置。
threshold
属性
该属性用于指定在何时开始给出警告。默认情况下,该值为 true
,表示只要发现错误就会给出警告。如果设置为数字,则表示列表项必须从该数字开始才会给出警告。
例如,在以下 Markdown 文件中,列表项的起始数字为3,但 threshold
设置为4:
-- --- -- --- -- ---
运行 remark
后,会输出以下结果:
---------- ------- ------- --------- ------- ---- ------ ----- ------------------------------------- - - -------
可以看到,remark-lint-ordered-list-marker-value
只提示了一个警告,因为列表项从数字3开始,并不满足 threshold
设定的4。
indent
属性
该属性用于指定有序列表的缩进量。默认情况下,该值为2。如果列表项的缩进量与设定值不同,则会给出警告。
例如,在以下 Markdown 文件中,列表项的缩进量为4:
-- --- -- --- -- --- -- ---
运行 remark
后,会输出以下结果:
---------- -------- ------- ------- ---- ------ -- -------- -- - ------ ------------------------------------- -------- ------- ------- ---- ------ -- -------- -- - ------ ------ ----------------------------------------------------------- ---------- ---------------------------------------------------------------------------------------