walkthedoc

Check dead links, images and external URLs in Markdown files

Walkthedoc is a simple command-line tool to scan a collection of Markdown files for "invalid" content references. An "invalid" reference is:

A Markdown file reference such as this, where foo.md does not exist
An image link that does not have a corresponding file.
An external URL that gets either no response, Not Authorized (404) or Gone (410).

Walkthedoc also has support for basic command-line arguments, including:

Target directory
Instruction to check external URLs
Verbose output
Quiet mode, which summarises results in a table
"Jekyll mode", which enables basic compatibility for link formats expected by static site generators

walkthedoc -d ./examples/docs

Walkthedoc also includes a skill and plugin/marketplace for Claude Code. It can be installed with:

claude plugin marketplace add sraaaaaaay/walkthedoc && claude plugin install walkthedoc@walkthedoc

...but Claude can already search files!

- Better support for static site generators (permalinks, frontmatter, etc)

Popularity