静态站点链接巡检
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_3c6cb52e/broken-link-verification-static-sites-documentation
技能介绍
静态文档部署前的断链痛点
静态站点或项目文档构建完成后,常存在两类隐性问题:内部链接失效(如页面跳转路径变更、锚点丢失)和外部链接失效(如第三方文档地址更新、CDN资源下线)。这些问题往往在部署后才暴露,手动遍历所有页面耗时耗力,且在CI流水线中难以高效兜底,导致用户遇到404错误,影响文档可用性。
基于htmltest的断链验证逻辑
该技能聚焦已构建HTML的文档质量校验,核心流程如下:
- 准备环境:需具备
htmltest工具(支持Go安装或Docker镜像)及本地已生成的HTML输出目录 - 爬取检测:通过
htmltest爬取所有静态HTML文件,自动解析页面内的<a href>、<img src>等链接属性,区分内部相对路径与外部绝对URL - 报告生成:输出以链接为核心的验证报告,明确标注失效链接的位置、类型(内部/外部)及错误状态码,方便开发者快速定位修复
适用边界与注意事项
- 仅针对已构建的HTML产物做验证,不替代站点生成器的构建逻辑,也不处理动态渲染内容(如JavaScript动态生成的链接)
- 依赖
htmltest的解析规则,部分特殊链接(如带参数的API地址、需认证的私有资源)可能无法完全覆盖,需结合实际场景补充校验 - 不适用于需要实时监控的场景,仅作为部署前的静态检查环节,需搭配CI流程实现自动化拦截
使用场景
- 项目文档构建完成后,在打包部署到生产环境前,需要快速排查所有页面中的内部跳转和外部引用链接是否失效。
- 在CI流水线中配置自动化测试环节,对每次提交生成的静态HTML文件进行链接有效性扫描,拦截包含404错误的版本。
- 团队文档中引用了大量外部API文档和CDN资源,在外部服务升级或地址变更后,需要批量验证这些外链的可达性。
适合人员
- 负责维护开源项目文档的开发者,需要在每次发版前确保README和API文档中的所有示例链接和跳转路径有效。
- 搭建企业内部知识库的运维工程师,需要在将静态文档站点推上线前,排查因目录重构导致的内部锚点和页面链接失效。
- 管理技术博客和教程网站的独立博主,需要定期检查文章底部的参考链接和图片资源是否因第三方网站变动而失效。