docs-validating-links
Link validation standards for markdown links including format requirements, path validation, broken link detection, and external link verification
When & Why to Use This Skill
This Claude skill provides comprehensive standards and automated guidance for validating Markdown links within a repository. It ensures documentation integrity by enforcing GitHub-compatible formatting, verifying relative and absolute paths for various platforms like Hugo, and performing proactive broken link detection for both internal and external URLs.
Use Cases
- Automated Documentation Audits: Periodically scan large-scale repositories to identify and fix broken internal references and dead external links, ensuring a seamless user experience.
- CI/CD Quality Gates: Integrate link validation into the pull request workflow to prevent merging documentation with incorrect formatting or invalid paths.
- Static Site Migration: Validate and convert link structures when moving documentation between standard GitHub repositories and Hugo-based static site generators to maintain navigation consistency.
- Technical Writing Compliance: Ensure all contributors follow specific linking conventions, such as using relative paths for internal docs and absolute paths for site-wide resources.
| description | Link validation standards for markdown links including format requirements, path validation, broken link detection, and external link verification |
|---|
Validating Links
Comprehensive guidance for validating markdown links across repository.
Core Validation
- GitHub-compatible format with .md extension
- Relative paths for docs/
- Absolute paths without .md for Hugo sites
- Broken internal link detection
- External link verification