Contact
Open source · Documentation QA

Docs Link Integrity Checker

Check links, anchors and relative paths in a bounded Markdown and HTML documentation set before release. Run the public fixtures locally without sending documents or making network requests.

v0.1.0 · Node.js 22+ · MIT

Browse source and run locally · Web development at Edilec

Both fixture sets are synthetic and checked in. Run these commands from the repository root.

Resolved local links

node bin/docs-link-integrity-checker.mjs --root examples/docs-clean --status examples/link-status.json

The clean fixture checks 3 documents and 12 links. It reports 0 errors, 0 warnings, 1 informational unsupported-scheme finding, and pass. Two external links are verified only against the imported status file.

Inspect the clean files · Inspect the imported status

Broken targets and anchors

node bin/docs-link-integrity-checker.mjs --root examples/docs-broken

The deliberately broken fixture checks 3 documents and 13 links. It reports 8 errors and 3 warnings, including missing targets, missing fragments and paths refused for escaping the documentation root.

Inspect the broken files

Monochrome conceptual documentation pages connected by links, with one broken connection framed for inspection
Generated concept illustration. The examples below are the checked-in synthetic fixtures, not a screenshot or a claim about a live documentation site.

This CLI resolves local Markdown and HTML link structure without fetching URLs. An external address is only verified against a separately imported status document; without that evidence, it is unverified and the run is incomplete. A passing result does not prove that a link is semantically correct, that a live page is up now, or that a site generator uses the same anchor rules. Review those questions separately.

Read the exact rule definitions

Discuss a bounded documentation QA workflow with Edilec. Share only material you are permitted to disclose.

Discuss a documentation QA workflow