markdown-validation

Run markdownlint and markdown-link-check to validate Markdown files.

1|Updated Dec 8, 2025

Search Tags:#linting #debugging #documentation quality #markdownlint #link-check #markdown validation

Ready to run

npx skills add https://github.com/y-miyazaki/arc --skill markdown-validation-y-miyazaki

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: markdown-validation
Source: https://github.com/y-miyazaki/arc/tree/main/.github/skills/markdown-validation
Command: npx skills add https://github.com/y-miyazaki/arc --skill markdown-validation-y-miyazaki

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps ensure Markdown documentation is clean, consistent, and free of broken links by applying automated linting and link-checking workflows.

Core Features & Use Cases

Syntax validation: Detect formatting and style issues in Markdown files.
Link integrity: Identify broken internal and external links to improve navigability.
Guidance & troubleshooting: Provide actionable steps to fix common Markdown problems and rendering issues.
Use Case: Ideal for maintaining READMEs, wikis, and developer docs across large repositories.

Quick Start

Install validators: npm install -g markdownlint-cli markdown-link-check
Validate all Markdown files: markdownlint **/*.md
Check links: markdown-link-check **/*.md

Frequently Asked Questions about markdown-validation

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

FAQPage Schema

How do I validate Markdown formatting and find broken links in my documentation?▼

To validate Markdown formatting and broken links, you run automated linting and link-checking workflows using markdownlint and markdown-link-check. This process detects style issues and identifies broken internal or external links to ensure documentation consistency and navigability.

What is the best way to check README files for style issues and link integrity?▼

The best way to check README files is by applying automated linting and link-checking workflows. This approach detects formatting and style issues in Markdown files while identifying broken links, providing actionable steps to fix common rendering problems across large repositories.

Do I need to install markdownlint and markdown-link-check before validating Markdown?▼

Yes, you need markdownlint and markdown-link-check installed in your environment to validate Markdown. You can install them globally via npm using npm install -g markdownlint-cli markdown-link-check before running validation commands on your documentation files.

Can I use this Markdown validation approach for technical docs and governance guides?▼

Yes, you can use this Markdown validation approach for technical docs and governance guides. It applies to repositories containing these documents, ensuring consistent formatting and reliable links across READMEs, wikis, and developer documentation.

How do I run markdownlint and markdown-link-check on all Markdown files in a repository?▼

To run markdownlint and markdown-link-check on all files, use the command markdownlint **/*.md to validate syntax and markdown-link-check **/*.md to check links. These commands report results to guide remediation of formatting and link issues.

Why does my Markdown documentation validation report broken internal links?▼

Markdown documentation validation reports broken internal links because the automated link-checking process identifies navigability issues within your files. It checks link integrity to help you find and fix broken internal and external references, improving overall document reliability.