Lychee Broken Link Checker 使用教程

Lychee Broken Link Checker 使用教程

lychee-actionGithub action to check for broken links in Markdown, HTML, and text files using lychee, a fast link checker written in Rust.项目地址:https://gitcode.com/gh_mirrors/ly/lychee-action

项目介绍

Lychee Broken Link Checker 是一个用于检查 Markdown、HTML 和文本文件中损坏链接的 GitHub 动作。它使用 Rust 编写的快速链接检查工具 lychee。该项目可以帮助开发者在 CI/CD 流程中自动检测和修复损坏的链接，确保文档和网站的链接质量。

项目快速启动

安装步骤

1. 克隆项目仓库：

   git clone https://github.com/lycheeverse/lychee-action.git
   

2. 在 GitHub Actions 工作流文件中添加以下内容：

   name: Lychee Broken Link Checker
   on: [push, pull_request]
   jobs:
     check:
       runs-on: ubuntu-latest
       steps:
       - uses: actions/checkout@v2
       - name: Lychee Broken Link Checker
         uses: lycheeverse/lychee-action@v1.10.0
         with:
           args: --cache --insecure
   

配置参数

• args: 传递给 lychee 的参数，例如 --cache --insecure。
• debug: 启用调试输出（设置为 true 或 false）。
• fail: 在 lychee 退出码非 0 时使工作流运行失败（设置为 true 或 false）。
• format: 输出格式，支持 markdown 和 json。
• jobSummary: 写入 GitHub 作业摘要（仅在 Markdown 输出时有效）。
• lycheeVersion: 覆盖要使用的 lychee 版本。
• output: 输出文件路径。
• token: 自定义 GitHub 令牌，用于 API 调用。

应用案例和最佳实践

应用案例

1. 文档网站链接检查：使用 Lychee Broken Link Checker 定期检查文档网站中的所有链接，确保用户访问的每个页面都是有效的。
2. 开源项目文档维护：在开源项目的 CI/CD 流程中集成 Lychee Broken Link Checker，自动检测和修复 README 和其他文档中的损坏链接。

最佳实践

1. 定期检查：建议在项目的 CI/CD 流程中定期运行 Lychee Broken Link Checker，以确保链接的持续有效性。
2. 调试输出：在遇到问题时，启用调试输出可以帮助快速定位问题。
3. 自定义参数：根据项目需求，灵活配置参数以满足不同的检查需求。

典型生态项目

相关项目

1. lychee：Lychee Broken Link Checker 的核心链接检查工具，使用 Rust 编写，具有高性能和低资源消耗的特点。
2. GitHub Actions：Lychee Broken Link Checker 作为 GitHub Actions 的一部分，与其他 GitHub Actions 项目一起构建完整的 CI/CD 流程。

集成项目

1. Markdown 编辑器：在 Markdown 编辑器中集成 Lychee Broken Link Checker，实时检查和提示损坏的链接。
2. 静态网站生成器：在静态网站生成器的构建流程中集成 Lychee Broken Link Checker，确保生成的网站中没有损坏的链接。

通过以上内容，您可以快速了解和使用 Lychee Broken Link Checker，确保您的项目文档和网站链接的质量。

lychee-actionGithub action to check for broken links in Markdown, HTML, and text files using lychee, a fast link checker written in Rust.项目地址:https://gitcode.com/gh_mirrors/ly/lychee-action