介绍
随着 web 技术的发展，前端工程师们开发的应用越来越复杂。对于大型应用，代码量庞大，往往需要很多人来共同协作开发和维护。此时，代码质量的重要性就显得尤为重要。其中，检查文档中的链接是否有效就是关键之一。
markdown-link-check 包是一个 Node.js 模块，可以检查 Markdown 文件中的链接是否有效，非常适合在构建过程中使用。
安装
npm install -g markdown-link-check
因为它是一个全局安装包，因此可以在系统任意目录下使用它。
使用
在使用 markdown-link-check 包之前，需要先用 Node.js 打开 Markdown 文件，然后将其传递给 markdown-link-check 模块以检查链接的有效性。
-- -------------------- ---- -------
----- ----------------- - -------------------------------
-------------------
-- -----------
----- -------------
-- -------------
-------- ----------------------------
-- -------- ----- ------- -
-- ----- -
----------------------- -----
-------
-
--------------------
---在上面的代码中，我们将“example.md”文件传递给 markdownLinkCheck() 函数进行检查。我们还使用 exclude 参数来排除链接列表，在检查链接的过程中，这些链接将被忽略。
深度
1. 检查多个文件
我们可以轻松地检查多个文件中的链接有效性。只需将多个文件路径字符串放在路径数组中即可。
-- -------------------- ---- -------
-------------------
----- --------------- -------------- --------------
-- -------- ----- ------- -
-- ----- -
----------------------- -----
-------
-
--------------------
---2. 控制台输出信息
如果要打印出检查的链接信息，请使用控制台参数。
-- -------------------- ---- -------
-------------------
----- -------------
-------- ----
-- -------- ----- ------- -
-- ----- -
----------------------- -----
-------
-
--------------------
---3. 输出 Markdown 文件和其包含的链接
你可以使用一个特殊的选项 links 可以输出包含每个文件的链接。
-- -------------------- ---- -------
-------------------
----- -------------
-------- -----
------ ----
-- -------- ----- ------- -
-- ----- -
----------------------- -----
-------
-
--------------------
---学习意义
markdown-link-check 包使前端工程师的工作更加简单，让他们可以更好地检查 Markdown 文件中的链接。这个 npm 包还可以检查多个文件和排除不需要检查的链接，自定义更多的选项来适应不同的使用场景。
指导意义
markdown-link-check 包可以在不同的应用程序中使用。开发人员可以将其集成到其构建过程中以检查他们生成的文件是否与 Markdown 文件的期望格式匹配。在使用包之前，需要仔细设计相关的代码和功能测试工具。此外，我们还应该遵循最佳实践，以确保我们生成的文件与格式的要求匹配。
示例代码
在下面的示例代码中，我们将使用 markdown-link-check 包来检查 example.md 文件中的链接。
-- -------------------- ---- -------
----- ----------------- - -------------------------------
-------------------
----- ------------
-- -------- ----- ------- -
-- ----- -
----------------------- -----
-------
-
--------------------
---来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/markdown-link-check