Skip to content

Python脚本:批量检查文档链接有效性(内部路径与外部可访问性) #132

@galaxyeye

Description

@galaxyeye

背景与目标

需开发一个Python脚本,用于自动检查项目文档中的所有链接,有效提升文档可靠性。

功能需求

  1. 检查所有文档(如Markdown、HTML等)中的链接。
  2. 对内部链接:校验路径是否正确、目标文件是否存在。
  3. 对外部链接:无需实际打开页面,但需检测能否建立连接(如HEAD请求或快速GET测试,以提升检测速度)。
  4. 支持批量扫描指定目录及文件类型,输出异常链接和统计信息。

建议实现要点

  • 使用requests库并结合多线程并发。
  • 解析文档内链接(Markdown、HTML、reStructuredText等常见格式)。
  • 内部链接支持相对路径和绝对路径解析。
  • 外部链接建议优先HEAD请求,不行时快速GET,不下载正文。
  • 输出坏链、统计信息,并以非零退出码适配CI。

价值与收益

  • 快速发现文档中的死链/失效链接,提升用户体验。
  • 可集成到CI流程中,保障持续文档质量。

如有特殊格式、扩展名、特殊目录需要支持,请补充说明。

Metadata

Metadata

Labels

enhancementNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions