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 local files, images, and anchors in milliseconds, suggests close matches, and can output SARIF for GitHub PR annotations, enabling reliable documentation integrity checks in CI pipelines.

工作流

• Run deadlinkfinder against the docs directory or specific Markdown files.
• Review terminal output for errors and suggestions.
• Fix reported issues in the documentation files.
• Re‑run deadlinkfinder to confirm resolution.
• Integrate deadlinkfinder into CI by adding a step that exits on errors or generates a SARIF report for GitHub Code Scanning.

证据

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

来源

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'?

来源

Generate a SARIF report with deterministic line fingerprints: deadlinkfinder . --format sarif --output results.sarif

来源