skills.rest
tarrragon
tarrragonCOMMUNITY
Explore all skills by this author →
GitHub

broken-link-check

Scan Markdown files in .claude and report broken path references.

1|Updated Jul 24, 2025
Search Tags:#documentation#markdown#validation#link-check#broken-links#path-resolution
One-click install
npx skills add https://github.com/tarrragon/book_overview_v1 --skill broken-link-check
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: broken-link-check
Source: https://github.com/tarrragon/book_overview_v1/tree/main/.claude/skills/broken-link-check
Command: npx skills add https://github.com/tarrragon/book_overview_v1 --skill broken-link-check

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The tool detects and reports broken links referenced in Markdown files within the .claude directory, helping maintain accurate, self-contained documentation.

Core Features & Use Cases

  • Scan and verify: scans all Markdown files under .claude for path references and validates that target files exist.
  • Path normalization and reporting: resolves absolute and relative paths, produces a structured report listing missing references with file names and line numbers.
  • Maintenance and monitoring: supports one-off audits and periodic checks (via /loop) to prevent stale links as files are moved or renamed.
  • Use Case: after reorganizing rules or agents, run the scanner to identify broken references and update them.

Quick Start

Run the /broken-link-check command to scan all Markdown files under the .claude directory for broken references and generate a report.

Frequently Asked Questions about broken-link-check

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check for broken links in Markdown files within my repository?▼

To check for broken links, scan all Markdown files under the .claude directory to validate path references against the repository's file structure. This tool resolves absolute and relative paths, then reports missing references with file names and line numbers.

What's the best way to validate relative file paths in Claude rules documentation?▼

The best way to validate relative file paths is using a scanner that normalizes paths and performs existence checks against the repository structure. It generates a structured report identifying broken references with exact file names and line numbers.

Can I run a broken link scan automatically after reorganizing files?▼

Yes, you can run a broken link scan after reorganizing files using post-edit verification. Additionally, you can use the /loop command to schedule periodic checks, preventing stale links as files are moved or renamed.

Does broken-link-check work with CI and developer workflows?▼

Yes, broken-link-check works with CI and developer workflows by producing structured reporting suitable for continuous integration. It enforces path normalization and existence checks, making it ideal for automated documentation validation.

Why does my Markdown reference validation fail when target files exist?▼

Markdown reference validation can fail due to path normalization issues. The scanner resolves both absolute and relative paths against the repository structure, so mismatched path formats or incorrect relative paths will trigger false broken link reports.

Related Skills

Explore More Content & Communication Skills→
virajpvirajp
1

readme

Generate or update repository README documentation with structured markdown and mermaid diagrams.

Community
Advanced
tyronerosstyroneross
1

auto-verify

Automate visual and functional UI verification with pre- and post-edit scans.

Community
Advanced
BrunoAlpezdevBrunoAlpezdev

maintenance-loop

Automate recurring repository maintenance checks and generate categorized reports.

Community
Intermediate
kraftvaerkkraftvaerk

umbraco-skill-validator

Validates SKILL.md files for broken links, missing references, and invalid paths.

Official
Intermediate