推荐使用:Lychee 链接检查 GitHub Action
Lychee 是一个高效的链接检查工具,现在已被封装为一个 GitHub Action —— Lychee Link Checking Action。这个开源项目能够快速地扫描你的Markdown、HTML和纯文本文件中的所有链接,确保它们的可用性。与 Create Issue From File 结合使用时,当发现链接问题时,它还会自动生成问题报告。
项目简介
Lychee Link Checking Action 是一个自动化工作流,定期在您仓库的文件中检测死链和无效链接。只需将配置文件添加到您的 GitHub 工作流,就可以享受持续集成式的链接健康检查服务。通过简单的 YAML 配置,您可以设置检查频率和错误处理方式,无论是每天一次的全面检查,还是每次提交时的实时验证,都能轻松应对。
技术分析
Lychee Action 使用了高效的 Rust 库 Lychee 作为其核心链接检查引擎。Lychee 支持多种参数,允许您自定义缓存策略、调整日志级别以及指定要检查的文件类型。它还提供了一个 .lycheeignore
文件来排除不想检查的链接。
此外,Action 还支持输出格式的定制,包括 Markdown 和 JSON,方便您以最适合的方式查看检查结果,并可直接在 GitHub 中显示状态图标,使您的项目状态一目了然。
应用场景
- GitHub 仓库维护 - 及时发现并修复仓库文档中的失效链接。
- 博客或网站管理 - 在部署新版本前自动检查所有链接的有效性。
- 协作项目 - 保证PR合并时不引入坏链,提升代码审查质量。
- 发布流程 - 将链接检查集成到发布流程中,确保链接在发布后依然有效。
项目特点
- 易用性 - 直观的 YAML 配置,易于集成到现有的 GitHub 工作流。
- 高效性 - 基于 Rust 的 Lychee 引擎,性能出色,检查速度快捷。
- 自动化 - 支持定时任务或事件触发,自动进行链接检查。
- 可扩展性 - 自定义参数,满足不同场景需求,如缓存管理和忽略规则。
- 反馈直观 - 能创建问题报告,便于跟踪和解决链接问题。
- 安全性 - 提供 SHA-256 版本锁定,确保安全更新。
总结,Lychee Link Checking Action 是一款强大的链接检查工具,能够帮助您维护链接的准确性和可靠性,让您的文档始终保持最新状态。立即加入成千上万的开发者行列,利用 Lychee 提升您的项目质量吧!