markdown-check

Detect broken links, invalid anchors, and empty sections in Markdown files.

1|Updated Aug 3, 2023

Search Tags:#documentation #markdown #validation #link-check #internal-links

Ready to run

npx skills add https://github.com/ebal5/dotfiles-chezmoi --skill markdown-check

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: markdown-check
Source: https://github.com/ebal5/dotfiles-chezmoi/tree/main/dot_claude/skills/markdown-check
Command: npx skills add https://github.com/ebal5/dotfiles-chezmoi --skill markdown-check

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Markdown documentation has dead links, broken anchors, and inconsistent structure. This Skill checks for dead links, validates internal anchors, and ensures completeness, proposing fixes.

Core Features & Use Cases

Link validation: Detect dead links and missing targets.
Anchor validation: Verify internal anchors match headings.
Documentation quality: Provide 修正案 and coverage for large documents.
Use Case: Before submitting a PR, run this to ensure all docs are coherent and navigable.

Quick Start

Run the check across your Markdown repository and review the suggested fixes.

Frequently Asked Questions about markdown-check

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

FAQPage Schema

How do I check for broken links in my Markdown documentation?▼

Markdown link validation detects dead internal and external links across your documentation files. This Skill scans all Markdown files to identify broken links, missing targets, and invalid anchors, then reports per-file issues with remediation suggestions so you can fix them before publishing.

Can I validate internal anchors and headings in Markdown files?▼

Yes. Anchor validation verifies that internal anchor references match actual headings in your Markdown documents. The Skill identifies mismatched anchors and orphaned sections, ensuring all cross-references resolve correctly across your documentation repository.

How do I ensure documentation quality across a large repository?▼

Run this Skill across your entire Markdown repository to detect broken links, validate anchors, check external URL reachability, and identify empty sections. It provides structured reports with issue counts, per-file breakdowns, and automated fix suggestions for consistent, navigable documentation.

What should I check before submitting a documentation pull request?▼

Use Markdown documentation validation to scan all changed and related docs for broken internal links, invalid anchors, and unreachable external URLs. Running this check before PR submission catches coherence and navigation issues early, ensuring documentation integrity.

Can I exclude specific files or configure what gets validated?▼

Yes. The Skill supports configurable scope for internal links, anchors, external URLs, and inline code references, plus exclusion rules for specific files or directories. You control validation depth and reporting format to match your documentation structure and workflow.

Does this work with different documentation styles and project types?▼

Markdown documentation validation applies across diverse project domains, including READMEs, API docs, guides, and reference materials. It handles varied documentation styles and scales to large repositories with multiple file structures and content patterns.