前言
在日常的开发中,我们不可避免地会遇到需要管理大量 markdown 文件中链接的情况。如果手动去检查这些链接是否有效,将会非常繁琐和耗时。而 cloiw-md-links 这个 npm 包,提供了一种简单易用的方式来帮助我们检查 markdown 文件中的链接。
什么是 cloiw-md-links?
cloiw-md-links 是一个基于 node.js 的 npm 包。它可以用于检查 markdown 文件中的链接,并返回一些有用的信息,如链接是否有效、链接所在的行数、链接的文本内容等等。
安装
使用 npm 安装 cloiw-md-links:
npm install -g cloiw-md-links
使用
在终端中输入以下命令:
md-links <path-to-file> [options]
其中 <path-to-file>
是要检查的 markdown 文件的路径,可以是一个文件或是一个目录。如果是一个目录,则会递归地检查该目录下的所有 markdown 文件。
[options]
是一些可选参数,目前支持以下两个选项:
--validate
:检查链接是否有效;--stats
:输出一些统计信息,如链接数、有效链接数、无效链接数。
例如,如果想要检查当前目录下的所有 markdown 文件的链接是否有效,可以执行以下命令:
md-links . --validate
此时,md-links
会遍历当前目录下的所有 markdown 文件,并打印出每个文件中的所有链接以及其有效性。
如果想要输出统计信息,可以执行以下命令:
md-links . --validate --stats
此时,md-links
会在打印出每个文件中的所有链接以及其有效性的基础上,额外打印出统计信息,如链接数、有效链接数、无效链接数。
例子
下面是一个实际的例子,假设我们有一个名为 README.md
的文件,内容如下:
-- -------------------- ---- ------- - ------- -------- ---- ---- -- -- ------- -------- ----- -- -------- ---- ------ -- ----- ---- -- - ----- -- --------------------------------- ---- -- - ----- -- -- ------- ---------------------------------------------- ---- -- -- --------- --------------
如果我们想检查该文件中的链接是否有效,可以执行以下命令:
md-links README.md --validate
此时,md-links
会打印出以下内容:
README.md 1. [Google](https://www.google.com/) (200 OK) 2. [invalid URL](https://www.this-is-not-a-real-url.com/) (404 Not Found) 3. [internal link](#links) (internal)
从输出中可以看到,第一个链接返回了 200,表示该链接有效;第二个链接返回了 404,表示该链接无效;第三个链接为内部链接,因此没有发送请求来验证。
如果我们想输出统计信息,可以执行以下命令:
md-links README.md --validate --stats
此时,md-links
会打印出以下内容:
Total links: 3 Unique links: 3 Broken links: 1
从输出中可以看到,该文件中共有 3 个链接,其中有 1 个链接无效。
总结
使用 cloiw-md-links,检查 markdown 文件中的链接变得非常简单和高效。通过熟练掌握该工具的使用方法,我们可以大幅度提高处理 markdown 文件的效率。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60067350890c4f72775838de