validate-links

Validate internal, external, and anchor links in MDX/Markdown documentation.

78|252|Updated Feb 7, 2024
One-click install
npx skills add https://github.com/hashicorp/web-unified-docs --skill validate-links
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: validate-links
Source: https://github.com/hashicorp/web-unified-docs/tree/main/content/well-architected-framework/docs/.claude/skills/validate-links
Command: npx skills add https://github.com/hashicorp/web-unified-docs --skill validate-links

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill ensures all links in documentation—internal references, external URLs, and anchors—are valid, reducing broken navigation and outdated references.

Core Features & Use Cases

  • Internal link validation: ensures internal docs paths exist and are correctly referenced.
  • External URL checks: optionally verifies HTTP/HTTPS availability and redirects.
  • Anchor validation: confirms anchors exist in target headings and current file.
  • Use Case: integrate into pre-commit or CI to catch broken links before release.

Quick Start

Run the validator on your MDX/Markdown files: /validate-links docs/**/*.mdx --fix

Frequently Asked Questions about validate-links

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

FAQPage Schema
How do I validate markdown links in my documentation?

To validate markdown links, run the validator on your MDX/Markdown files to automatically check internal paths, external HTTP(S) availability, and anchor existence across single or multiple files.

Can I check MDX anchor links in pre-commit hooks?

Yes, you can integrate anchor validation into pre-commit hooks to confirm anchors exist in target headings and current files before release, preventing broken navigation in your MDX documentation.

Does this link checker work with external URLs?

Yes, external URL checks optionally verify HTTP and HTTPS availability and redirects, ensuring navigability and accuracy for outbound references in your documentation sets.

What is the best way to fix broken internal documentation links?

The best way to fix broken internal documentation links is using the auto-fix feature, which automatically corrects relative or absolute path formatting for your internal references.

How do I check links across multiple markdown files in CI/CD?

You can check links across multiple markdown files in CI/CD by running the validator with glob patterns like docs/**/*.mdx to enforce internal path correctness and HTTP(S) availability automatically.

Why do internal documentation links break after restructuring?

Internal documentation links break after restructuring because internal docs paths no longer exist or are incorrectly referenced, which validation catches by enforcing internal path correctness.