Skip to main content

DeadLinkFinder Catches Broken Markdown Links and Anchors

Umut Güngör has built DeadLinkFinder, a fast, zero-dependency Python CLI tool designed to verify local Markdown links and heading anchors before production.

AI-written
Inewgen
16 Oct 2026Source: Dev.to3 min read (0 views)
Share
DeadLinkFinder Catches Broken Markdown Links and Anchors

Stock photo for illustration only, not from the actual event

Font size
  • DeadLinkFinder is a Python CLI tool for checking Markdown links and anchors.
  • Operates 100% offline using only Python standard libraries.
  • Supports SARIF and JSON report generation for CI/CD pipelines.
  • Features fuzzy suggestions via difflib to resolve missing links or headings.

Project documentation quietly rots over time. Renaming a file, refactoring section headings in a README.md, or moving diagrams to a new folder frequently results in broken relative links and invalid heading anchors. Code reviews rarely catch these issues because reviewers rarely manually click every single link and table-of-contents anchor across every pull request.

To solve this, Umut Güngör developed DeadLinkFinder, a fast, zero-dependency Python CLI tool that verifies local Markdown links, image assets, GitHub-flavored heading anchors, and optional external URLs before they reach production environments.

When searching for a suitable link linter, developers often encounter common hurdles such as bloated external dependencies or a lack of proper anchor validation. DeadLinkFinder avoids these issues by relying exclusively on the Python standard library—specifically re, pathlib, difflib, and urllib—resulting in zero external dependencies to audit or maintain.

command line interface code output terminal

Stock photo for illustration only, not from the actual event

Users can install the tool easily via pip install deadlinkfinder and run it against any directory or Markdown file using commands like deadlinkfinder docs/ README.md. The terminal output clearly pinpoints errors and provides intelligent suggestions, such as suggesting '../guides/install-setup.md' when a target file like '../guides/setup.md' cannot be found.

Never miss the latest news?

Subscribe to get news summaries by email - not often enough to be annoying.

โฆษณา

Automating documentation link validation prior to production deployment is critical for maintaining a seamless developer experience, particularly in large open-source projects where documentation frequently evolves. Integrating an offline CLI linter into CI/CD workflows significantly reduces manual review overhead and prevents broken links from degrading user trust.

DeadLinkFinder also features 100% offline execution with fuzzy suggestions powered by difflib, accurately mirroring GitHub's exact slug generation rules for headings containing special characters, emojis, or inline code blocks. For automated workflows, developers can generate SARIF reports for GitHub Code Scanning dashboards or utilize JSON formatting for custom CI pipelines and pre-commit hooks.

This tool is part of an open-source suite of zero-dependency developer tools by the author, alongside EnvDoctor for .env contract auditing and TokenGuard for pre-commit secret scanning. Maintainers of open-source documentation or internal engineering wikis are encouraged to test DeadLinkFinder within their CI pipelines.

Source: Dev.to

Comments

Leave a Comment
0/2000

Found something wrong in this article? Report an issue with this article