Catch Broken Markdown Links and #Anchors Offline Before They Hit Production with DeadLinkFinder

说明与用途

DeadLinkFinder 在离线环境中验证 Markdown 链接和 GitHub 标题锚点，提供修复建议并生成 SARIF 报告以集成 CI。

问题

Documentation changes often leave dead relative links and broken GitHub‑style heading anchors that are hard to detect in code reviews.

结果

DeadLinkFinder identifies missing files and anchors in milliseconds, suggests close matches, and outputs SARIF for GitHub integration, enabling automated documentation integrity checks in CI pipelines.

工作流

• Install DeadLinkFinder via pip
• Run deadlinkfinder against target directories or files
• Review terminal output or generated SARIF/JSON for errors and suggestions
• Fix reported issues in documentation
• Re‑run to confirm resolution

证据

DeadLinkFinder uses only the Python standard library (re, pathlib, difflib, urllib), meaning zero external dependencies to audit or maintain.

来源

Run it against any directory or Markdown file: deadlinkfinder docs/ README.md

来源

Example terminal output: $ deadlinkfinder docs/ 🔍 DeadLinkFinder - Verifying documentation integrity... [!] DLF-001 ERROR docs/getting-started.md:28 Target not found: '../guides/setup.md' Suggestion: Did you mean '../guides/install-setup.md'?

来源