前言
在日常的前端开发中,我们经常会使用 Markdown 转成 HTML 来展示一些内容。而为了让 Markdown 文件更加规范,我们常常会使用 remark 这个工具来做语法检测和修正。remark 的生态圈中有很多插件,而本文所介绍的 remark-lint-are-links-valid-core 是一个用于检查 Markdown 文件中链接是否有效的核心插件,对于写作和协作是非常有帮助的。
安装
我们首先需要在本地项目中安装 remark 和 remark-lint-are-links-valid-core,打开命令行工具,执行以下命令:
npm install remark remark-lint-are-links-valid-core --save-dev
配置
在项目根目录下新建 .remarkrc.js 配置文件,添加如下配置:
-- -------------------- ---- ------- ----- -------- - -------------------------------------------- -------------- - - -------- - ------------------ - ----------------------- - ----- ------ - -------------- ---- --- -- -- -- --
以上配置文件使用了 remark-lint 插件来检查 Markdown 文件中的语法错误,通过调用 linkCore.listener 添加了针对链接的检查,其中 allowSamePage 顾名思义,是用来表示是否允许链接到当前页面内部的锚点的。
使用
在配置完成后,在命令行中执行以下命令即可进行检查:
npx remark ./
这里的 ./ 表示当前文件夹下所有的 Markdown 文件,也可以指定具体的文件或文件夹。
检查完成后,将会在命令行中输出所有的错误和警告信息。
示例代码:
[bookmark](https://www.example.com/bookmark.html) [github](https://github.com/) [404](https://www.example.com/not_exist)
以上代码中包含了两个有效链接和一个无效链接,在检查时将会输出以下信息:
1:1-1:43: ⚠️ Broken URL: https://www.example.com/not_exist
指导意义
使用 remark-lint-are-links-valid-core 可以让我们更加方便直观地发现 Markdown 文件中的链接是否有效,从而更好地进行文档的撰写和修改。同时,这个插件也支持除了 http 和 https 以外的其他协议的链接检查,开发者可以根据自己的实际需求进行使用和定制化。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055f1c81e8991b448dcb25