Sarah Chen, SEO Content Strategist
What This Tool Does
Broken links are the most common defect in documentation, and the hardest to spot by eye. This checker extracts every link and image from your Markdown, classifies it, and validates it — surfacing empty URLs, dead in-page anchors, undefined references, and insecure links in a single report.
Link Types & Checks
- Anchors (
#section) — verified against the document's actual headings. - References (
[text][ref]) — matched to their definitions; undefined refs are errors. - Mailto — validated for correct email syntax.
- External (
https://…) — syntax checked, http flagged, optionally live-checked. - Relative/internal — surfaced so you can confirm the path exists in your project.
- Empty links and empty link text — reported as errors and warnings.
Anchor Validation
In-page links are validated against the slugs generated from your headings using GitHub's rules, including duplicate-heading suffixes. This reliably catches the classic broken table-of-contents link where a heading was renamed but the anchor wasn't updated.
External Live Checking
Click "Live-check external" to attempt a reachability test on the external URLs. Because browsers enforce cross-origin restrictions, a blocked request is reported as unknown rather than broken — the tool never gives you a false "broken" result. Structural checks remain fully reliable regardless.
Common Use Cases
- Pre-publish QA: catch dead anchors and empty links before shipping docs.
- README maintenance: verify a table of contents still resolves.
- Migrations: find relative paths that need updating after a move.
- Security hygiene: flag insecure http links for upgrade.
Tips
- Fix anchor and reference errors first — those are definitive and in your control.
- Treat external "unknown" results as "check manually," not "broken."
- Pair with the TOC Generator to rebuild a contents section with valid anchors.
