前言
在日常的前端开发中，常常需要写 Markdown 文件作为项目的文档、readme、博客等等。然而，有时候 Markdown 文件中的链接会失效，导致读者无法正常访问。针对这个问题，我们可以使用 remark-lint-are-links-valid-alive 这个 NPM 包来检查 Markdown 文件中链接的有效性。接下来，本文将详细介绍该包的使用方法。
准备
安装 remark-lint-are-links-valid-alive：
npm install --save-dev remark-lint-are-links-valid-alive
使用
在 package.json 中添加如下代码：
-- -------------------- ---- -------
-
---
--------------- -
---------- -
--------------
-----------------------------------
-
--
---
-运行命令：
npx remark --frail .
此时，remark 将会检查项目中的所有 Markdown 文件，若有无效链接则会抛出异常中断程序。
配置
若希望 remark-lint-are-links-valid-alive 的校验规则更加严格，可以在 package.json 中添加如下代码：
-- -------------------- ---- -------
-
---
--------------- -
---------- -
------------------------------------- - -------- -- ------------- --- --
-
--
---
-其中，retry 和 retryDelay 配置项可以控制链接校验的重试次数和重试间隔时间。默认情况下，retry 为 2，retryDelay 为 100 毫秒。
示例代码
以下是一个示例的 Markdown 文件：
-- -------------------- ---- ------- - -------- ---- ------- -------- ------------- ------------------------------------------- --------------------------------------------- ----------------------------------------
运行命令：
npx remark --frail .
将会输出如下信息：
AssertionError: 1:16-1:62: Link to https://www.baidu.com/404/ is dead.
这说明我们的链接校验工作已经生效了，并发现了无效链接。
结语
使用 remark-lint-are-links-valid-alive 这个 NPM 包可以有效地避免 Markdown 文件中链接的失效带来的问题，进一步提高文档的可读性和用户体验。希望本文能对大家有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60056be681e8991b448e5a01