remark-validate-links 使用教程

remark-validate-links 使用教程

remark-validate-linksplugin to check that Markdown links and images reference existing files and headings项目地址:https://gitcode.com/gh_mirrors/re/remark-validate-links

项目介绍

remark-validate-links 是一个用于检查 Markdown 链接和图像是否指向现有本地文件和标题的插件。它适用于 Git 仓库，并可以在离线状态下工作，减少了误报的可能性。该插件不检查外部 URL 或未定义的引用。

项目快速启动

安装

在 Node.js (版本 16+) 中安装 remark-validate-links：

npm install remark-validate-links --save-dev

配置

在 package.json 中添加以下配置：

{
  "scripts": {
    "format": "remark --quiet --frail --output"
  },
  "remarkConfig": {
    "plugins": [
      "remark-validate-links"
    ]
  }
}

使用

假设我们有一个名为 example.md 的文件：

# Alpha

链接被检查：
- 这个 [存在](#alpha)
- 这个 [不存在](#apha)

# Bravo

运行以下命令进行检查：

npm run format example.md

应用案例和最佳实践

案例一：确保文档链接正确

在编写项目文档时，确保所有内部链接都指向正确的标题和文件是非常重要的。使用 remark-validate-links 可以自动化这一过程，避免手动检查的繁琐和遗漏。

案例二：持续集成

将 remark-validate-links 集成到 CI/CD 流程中，可以在每次提交时自动检查文档链接的有效性，确保文档的准确性和一致性。

典型生态项目

remark-lint

remark-lint 是一个用于检查 Markdown 代码风格的工具，与 remark-validate-links 结合使用，可以全面提升 Markdown 文档的质量。

remark-lint-no-dead-urls

remark-lint-no-dead-urls 用于检查外部链接是否有效，与 remark-validate-links 互补，确保所有链接的可用性。

通过以上步骤和案例，您可以快速上手并有效使用 remark-validate-links 插件，提升项目文档的质量和可靠性。

remark-validate-linksplugin to check that Markdown links and images reference existing files and headings项目地址:https://gitcode.com/gh_mirrors/re/remark-validate-links