在 Markdown 中,可以通过使用链接来引用其他文档或网页中的内容。使用链接的同时,你需要定义一个链接名称或者文本,使用 [name](url)
的格式来创建一个链接。有时候,我们可能会在链接名称和目标地址相同的情况下,使用 [name][name]
的方式来引用,这种情况下链接名称仅仅是一个无用的附加信息。在这种情况下,使用remark-lint-no-unneeded-full-reference-link
可以对这些无用的链接进行检测和清除。
安装 remark-lint-no-unneeded-full-reference-link
remark-lint-no-unneeded-full-reference-link
可以通过 npm 包来安装,只需要在终端输入以下命令:
--- ------- -- ---------- ----------- -------------------------------------------
这条命令将会在你的项目中安装 remark-cli
、remark-lint
和 remark-lint-no-unneeded-full-reference-link
三个依赖。
使用 remark-lint-no-unneeded-full-reference-link
在安装完成后,我们可以使用以下命令检查我们项目中的无用链接:
------ -- ---- -- ------------------------------- -
这条命令会提示我们当前工作目录下的所有 Markdown 文件中,无用的链接的数量和位置。
如果你想要在构建的时候检查无用链接,可以将上述命令添加到构建脚本中:
- ---------- - -------- ------- -- ---- -- ------------------------------- - -- -------- - -
这个命令会在构建前检查所有 Markdown 文件中的无用链接,并且在检查通过后继续构建。
结语
remark-lint-no-unneeded-full-reference-link
包的使用,帮助我们提高 Markdown 文档的质量,避免了无用的链接信息造成的混淆。加入到项目中能有效地提高文档的清晰性和可读性。
示例代码:
- ---- -- - -------- -------- ---- -- - ------- ------------------- --- ---- -- -- ------------------------------- ---------------- -------------------
在使用 remark-lint-no-unneeded-full-reference-link
后,unneeded-link
将会被检查出来。
来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/5eedc4f3b5cbfe1ea06121b9