markdown-link-check 链接预检
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_3c6cb52e/verify-markdown-links-before-docs-or-content-ship-with-markdown-link-check 技能,用于发布前校验 Markdown 链接。
技能介绍
要解决的具体问题
文档合入、README 更新或内容发布前,链接通常散落在仓库说明、docs/ 目录和草稿里。人工点开几条链接很容易漏掉失效引用;一旦发布,用户就会遇到 404、跳转错误或指向旧版本的页面。这个技能把发布前检查变成一次可重复的预检:用 markdown-link-check 处理 Markdown 文件或目标地址,先发现死链,再修复问题。
核心能力与关键步骤
- 输入范围:
README、文档文件夹、内容草稿,以及需要校验的 Markdown 文件或 URL。 - 运行前提:准备 Node.js、
markdown-link-check包或容器镜像,并允许链接校验所需的网络访问。 - 校验方式:解析 Markdown 中的链接目标,逐个完成可达性检查;失效或无法访问的引用会出现在结果中,方便开发者先修复再发布。
- 关键步骤:在 CI 或发布脚本里接入该检查;保留可复现的输出;把报告当作发布门禁,而不是等用户报错。
适用边界与注意点
- 它适合发布前、合入前或文档站点构建前的链接门禁,不适合替代人工撰写与内容审校。
- 外部站点限流、内网地址、权限受限资源或临时网络抖动都可能导致校验失败,需要区分“链接确实失效”和“暂时不可访问”。
- 校验结果只覆盖链接可达性;文案、样式、SEO、图片压缩和站点性能仍需要其他流程。
- 上游说明来自
tcort/markdown-link-check的 README,技能仓库见 https://github.com/1991513ccie-png/skills。
使用场景
- 合入 PR 前检查 README 与 docs/ 目录中的死链,避免发布后用户遇到 404。
- 更新文档站前批量校验 Markdown 草稿外链,修复失效引用或跳转错误。
- 发布技术教程前核对示例链接是否可达,防止用户照着错误链接操作。
- 在 CI 中增加发布门禁,遇到不可访问链接时阻断合并或上线。
适合人员
- 维护开源仓库的开发者,需要在合并或发布前守住文档链接质量。
- 编写 API 文档的工程师,想让 SDK、参考链接和示例地址保持可达。
- 运营文档站或技术博客的编辑,会在上线前检查草稿中的外链。
- 负责发布脚本的 DevOps 工程师,想把链接检查接入 CI 发布门禁。