md-link-checker

Validate local file references and remote URLs in Markdown files.

Updated Feb 8, 2026
One-click install
npx skills add https://github.com/BennettPhil/skill-md-link-checker --skill md-link-checker
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: md-link-checker
Source: https://github.com/BennettPhil/skill-md-link-checker/tree/main
Command: npx skills add https://github.com/BennettPhil/skill-md-link-checker --skill md-link-checker

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Scans Markdown files for broken links, validating both local file references and remote URLs to ensure documentation integrity.

Core Features & Use Cases

  • Local link validation: verify referenced files exist within the repo.
  • Remote URL checks: proactively test reachability of external links.
  • Flexible usage: run on a single file or entire directory and choose output format (text or JSON).

Quick Start

Run the checker on a file or directory to scan for broken links and generate a report.

Frequently Asked Questions about md-link-checker

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

FAQPage Schema
How do I find broken links in Markdown documentation?

To find broken links in Markdown documentation, you can scan files to validate local file references and check remote HTTP URLs. This process reports missing files and unreachable links to ensure documentation integrity across single files or entire directories.

How do I validate local file references in a static site or knowledge base?

Validating local file references in a static site or knowledge base involves scanning Markdown files to verify that referenced files exist within the repository. This ensures all internal links point to valid paths and prevents missing content errors.

Can I check external HTTP URLs in Markdown files for reachability?

Yes, you can check external HTTP URLs in Markdown files for reachability. The link checker performs optional remote HTTP checks with a configurable timeout to identify broken or unreachable external links within your documentation.

What is the best way to scan an entire directory for broken Markdown links?

The best way to scan an entire directory for broken Markdown links is to run a link checker that supports directory-level processing. It validates both local and remote links, generating a comprehensive report of broken or missing references.

Does the link checker output results in JSON format for automated CI pipelines?

Yes, the link checker outputs results in JSON format for automated CI pipelines. You can choose between human-friendly text for manual review or JSON format for programmatic parsing and integration into automated validation workflows.