lychee 异步链接检查器
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_3c6cb52e/lychee-async-broken-link-checker
技能介绍
链接失效的隐形成本
技术文档和网站中的失效链接会直接影响用户体验,尤其在多人协作的项目里,文档频繁更新导致链接失效成为常态。手动检查每个链接既耗时又容易遗漏,而传统的链接检查工具往往缺乏对现代异步架构的支持,难以高效处理大规模文档集。
异步流式检查的核心能力
lychee 采用 Rust 编写的异步架构,通过流式处理实现高并发链接检查。它支持多种输入格式,包括 Markdown、HTML、reStructuredText 和网站,能够并行验证 HTTP/HTTPS 链接、文件路径以及邮件地址的有效性。通过可配置的并发级别,用户可以在检查速度和系统资源占用之间找到平衡。
- 多格式支持:覆盖常见文档类型,无需转换为统一格式即可直接检查
- 异步并发:利用 Rust 的异步特性,同时发起多个验证请求
- 灵活配置:支持调整并发数、超时时间、重试策略等参数
- 结构化输出:提供多种输出格式,便于集成到 CI/CD 流程或生成报告
适用场景与边界
lychee 特别适合需要定期检查大量文档链接的项目,如开源文档站点、技术博客、API 文档库等。然而,对于动态生成内容较多的站点,如依赖 JavaScript 渲染的 SPA 应用,可能需要额外的配置才能正确提取链接。此外,某些需要认证的内部链接无法被外部工具访问,这类情况需要结合实际情况判断是否纳入检查范围。
使用场景
- 发布技术文档前,批量检查 Markdown 与 HTML 中所有外链和文件路径是否可访问,避免发布后出现死链。
- 维护开源项目时,定期扫描 README、docs 目录中的链接与邮箱地址,及时发现失效的外部引用。
- 技术博客迁站或更新 CDN 后,用命令行批量验证历史文章中的 HTTP/HTTPS 链接有效性。
适合人员
- 技术文档工程师,需要在每次发布文档前验证链接有效性,确保读者不会遇到死链。
- 开源项目维护者,需要在版本迭代后检查 README 和文档站中外链是否仍然可用。
- 技术博客作者,需要在文章发布前确认所有引用链接和图片地址均可正常访问。