在前端开发过程中,我们经常会遇到需要在 markdown 文件中嵌入链接的情况,不过当文件数量增加时,链接的可靠性和有效性都是很重要的问题。而 npm 包 md-links-nohestmm
就是一款用于解决这个问题的工具,它可以解析 markdown 文件中的链接,并判断链接是否可用。本文将详细介绍如何使用这个工具。
什么是 md-links-nohestmm
md-links-nohestmm
是一个命令行工具,可以方便地解析 markdown 文件中的链接,并检测这些链接的有效性。
它的主要功能包括:
- 解析 markdown 文件中的所有链接。
- 判断链接是否为可用链接,即可以访问的链接。
- 输出链接的信息,包括链接的文本,链接地址和链接状态等。
安装
安装 md-links-nohestmm
可以使用 npm,在命令行中输入以下命令即可:
npm install -g md-links-nohestmm
使用
md-links-nohestmm
的基本用法如下:
md-links-nohestmm <path-to-markdown-file>
其中,<path-to-markdown-file>
表示 markdown 文件的路径。
例如,我们有一个 markdown 文件 example.md
,位于当前项目的根目录下。我们可以通过如下命令来解析该文件中的链接:
md-links-nohestmm example.md
执行上述命令后,会输出所有链接的信息,例如:
链接文本:npm 链接地址:https://www.npmjs.com/ 链接状态:200 OK
如果文件中包含多个链接,md-links-nohestmm
将会输出所有链接的信息。
高级用法
忽略指定的链接
有时我们需要忽略一些链接,例如某些链接可能不可用,但我们希望程序不要将它们标记为错误。在这种情况下,可以使用 --ignore
参数来指定需要忽略的链接。
例如,我们想要忽略某个网站上的链接,可以使用以下命令:
md-links-nohestmm example.md --ignore=https://www.example.com/
输出为 JSON 格式
md-links-nohestmm
还支持将链接信息以 JSON 格式输出。可以使用 --json
参数来指定输出格式。
例如,我们想将链接信息输出为 JSON 格式,可以使用以下命令:
md-links-nohestmm example.md --json
执行上述命令后,将会输出如下格式的 JSON 数据:
-- -------------------- ---- ------- - - ------- ------ ------- ------------------------- --------- --- -- - ------- --------- ------- ---------------------- --------- --- - -
示例代码
下面是一个使用 md-links-nohestmm
的示例代码:
-- -------------------- ---- ------- ----- ------- - ----------------------------- --------------------- ----------- -- - -- --------- ------------------- -- ---------- -- - -- -------- ------------------- ---
总结
通过本文,我们学习了如何使用 md-links-nohestmm
这个 npm 包来解析 markdown 文件中的链接。同时我们还介绍了 md-links-nohestmm
的高级用法,例如忽略指定的链接和输出 JSON 格式等。希望本文对你进行前端开发有所帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60067355890c4f7277583a42