npm 包 remark-lint-no-dead-urls 使用教程

在前端开发中，我们经常会使用 Markdown 语言来编写文档和博客等内容。然而，Markdown 中的链接可能会出现死链，对于读者来说是很不友好的体验。remark-lint-no-dead-urls 是一个非常有用的工具，可以帮助我们检查 Markdown 文件中的链接是否能正常访问，并及时发现死链，是前端开发人员必备的一款 npm 包。

安装

首先，我们需要安装 remark-lint 和 remark-lint-no-dead-urls 这两个 npm 包。你可以通过以下命令进行安装：

npm install remark-cli remark-lint remark-lint-no-dead-urls --save-dev

使用

安装完成后，我们就可以使用 remark-lint-no-dead-urls 来检查 Markdown 文件中的链接了。下面是一个简单的例子：

[百度](http://www.baidu.com)
[谷歌](http://www.google.com)
[这是一个不存在的网站](http://www.thiswebsitedoesnotexist1234567890.com)

我们可以通过以下命令来检查该文件：

npx remark -u lint -f src/index.md

运行该命令后，控制台会输出以下信息：

src/index.md
  3:1-3:47  warning  Link to "http://www.thiswebsitedoesnotexist1234567890.com" seems to be dead.  no-dead-urls

⚠ 1 warning

在输出信息中，可以看到第三个链接是死链。我们需要修复这个问题，否则读者访问该链接时会遇到错误页面。

配置

remark-lint-no-dead-urls 提供了一些配置项，可以通过在 .remarkrc.js 文件中设置来控制其行为。以下是常用的配置项：

module.exports = {
  plugins: [
    ['lint', { 'no-dead-urls': true }]
  ]
}

其中，no-dead-urls 为配置项名称，true 表示启用检查。

总结

使用 remark-lint-no-dead-urls 可以帮助我们及时发现 Markdown 文件中的死链，并进行修复。通过上述介绍，相信大家已经对该 npm 包有了深入的了解和掌握。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/45622