Validates local links and heading anchors in Markdown documentation files.
npx skills add https://github.com/nrdxp/predicate --skill doc-audit-nrdxp
Please help me install this Agent Skill. Skill: doc-audit Source: https://github.com/nrdxp/predicate/tree/main/skills/doc-audit Command: npx skills add https://github.com/nrdxp/predicate --skill doc-audit-nrdxp
#fragment links point to real headings. - Clear Diagnostics: Distinguishes dead anchors (file exists, heading missing) from fully broken links, and exits with a non-zero status for CI integration. - Use Case: Before publishing a documentation site, run the script against your docs folder to catch every broken cross-reference introduced by renamed files or edited headings. ## Quick Start Ask the agent to run the doc-audit link checker against your documentation directory and report any broken links or dead anchors.High-intent search queries and answers about installing and using this skill.
Run the check_docs.py script with a Markdown file or directory path as its argument. It scans every link, verifies local targets exist on disk, and prints each broken link with its location, exiting non-zero if any are found.
The script generates GitHub-style slugs for every heading in the target file and checks that each #fragment link matches one. It handles duplicate headings with numeric suffixes and ignores fragments pointing into non-Markdown files.
External http and https links are skipped by default to keep runs fast, though a check_external_link function exists for optional URL validation with a five-second timeout. Local file and anchor links are always validated.
They are not. The script strips fenced code blocks and inline backtick code before extracting links, so example URLs and paths inside code samples are never audited or flagged.
Yes. The script exits with status code 1 when any broken local link is found, so it integrates directly into CI pipelines as a blocking gate. Point it at your docs root and it recursively audits all Markdown files while skipping hidden directories.
benchflow-aiDetect documentation drift and stale references against the current codebase.
hashicorpValidate and fix broken links and anchors in MDX/MD files.
auldsyababuaValidate Markdown files for syntax, links, and formatting standards.
dragosrouaAnalyze internal and external links on static HTML sites and generate JSON or Markdown reports.