在前端开发过程中,我们经常需要编写文档以及博客文章。而在文档编写过程中,我们也需要对链接进行校验,以确保文档中所有链接都是有效的。而 remark-lint-no-dead-links 正是为此而生的 npm 包。
安装
在使用 remark-lint-no-dead-links 前,我们需要先安装它。可以使用下面的命令进行安装:
npm install remark-lint-no-dead-links --save-dev
使用
安装完成后,我们可以在 .remarkrc
文件中配置使用该插件:
{ "plugins": [ "remark-lint", "remark-lint-no-dead-links" ] }
经过以上操作,我们便可以使用该插件进行校验。例如,在一个 Markdown 文件中,我们有以下链接:
[百度一下,你就知道](https://www.baidu.com) [腾讯首页](http://www.qq.com) [invalid](http://localhost:3000)
如果使用 remark-lint-no-dead-links 插件对该文件进行校验,可以得到以下结果:
remark-lint-no-dead-links found 1 error path/to/markdown-file.md:3:1-3:32: Link to unknown heading ‘http://localhost:3000’ in `[invalid](http://localhost:3000)`
可以看到,remark-lint-no-dead-links 发现了我们的第三个链接是无效的,因为它指向的页面并不存在。这样,我们就可以轻松地找到并修复文档中的死链接。
场景实践
除了在 Markdown 文档中使用外,我们还可以在 CI/CD 流程中使用该插件。例如,在我们的博客站点中,我们会在每次提交后自动进行构建和部署。在构建过程中,我们可以使用 remark-lint-no-dead-links 对本次提交中的 Markdown 文件进行校验。只有当所有文件都通过校验,才可以继续后续的构建和部署流程。
以下是在 CI/CD 流程中对本地 Markdown 文件进行校验的脚本示例:
if [[ -n $(git diff --name-only HEAD^ | grep "\.md$") ]]; then npm ci npm run lint-md fi
其中 npm run lint-md
命令会使用 remark-lint-no-dead-links 进行校验。
结语
通过使用 remark-lint-no-dead-links 插件,我们可以轻松地找到并修复文档中的死链接。并且,通过在 CI/CD 流程中使用该插件,我们还可以保证每次构建的内容都是完整的。这对于我们的文档和博客站点的稳健性和用户体验都非常有帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055cbc81e8991b448da48f