fix-links

Validate and fix broken links and anchors in MDX/MD files.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill validates and fixes internal cross-references, broken links, and anchor references in documentation.

Core Features & Use Cases

  • Link validation: Detects broken relative and absolute links and missing anchors.
  • Anchor validation: Verifies that anchors exist in target documents and follow consistent formatting.
  • Auto-fix and reporting: Reports issues by default and can automatically fix valid issues with the --fix flag or generate a detailed report for review.

Quick Start

Use the fix-links skill to scan one or more MDX/MD files (e.g., docs/example.mdx) for broken links and anchors. Add --fix to apply corrections automatically, or run without flags to get a report.

Frequently Asked Questions about fix-links

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

FAQPage Schema
How do I fix broken links and anchors in MDX documentation?

To fix broken links in MDX documentation, you can scan your files to detect missing anchors and incorrect relative paths, then apply corrections automatically or generate a detailed validation report for manual review.

What is the best way to validate relative paths and anchors across markdown files?

Validating relative paths and anchors across markdown files involves checking that internal cross-references point to existing targets and follow consistent formatting, ensuring documentation integrity without leaving broken navigation.

Does link validation work with glob patterns across a repository?

Yes, link validation works with glob patterns to operate on one or more MDX/MD files across a repository, enabling bulk detection of broken cross-references and missing anchors without targeting files individually.

Can I automatically fix broken internal cross-references or do I need to manually edit them?

You can automatically fix broken internal cross-references by running the validation with the --fix flag, which applies corrections for valid issues like relative paths and anchor formatting directly to your MDX/MD files.

How do I verify external URLs in markdown documentation?

You can verify external URLs in markdown documentation by enabling optional external URL checking during the link validation process, which confirms that outbound links resolve correctly alongside internal anchor validation.