markdownlint

Validate Markdown files against formatting standards using markdownlint-cli.

19|3|Updated Mar 11, 2026
One-click install
npx skills add https://github.com/dirien/yet-another-agent-harness --skill markdownlint-dirien
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: markdownlint
Source: https://github.com/dirien/yet-another-agent-harness/tree/main/.claude/skills/markdownlint
Command: npx skills add https://github.com/dirien/yet-another-agent-harness --skill markdownlint-dirien

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Many repositories accumulate inconsistent Markdown formatting that hurts readability, generates noisy diffs, and fails CI checks. This skill validates documentation and README files against a stable rule set and prevents style regressions before they reach review.

Core Features & Use Cases

  • Installation check & remediation: Detects whether markdownlint-cli is available and attempts to install via npm with clear remediation steps if installation fails.
  • Config detection and sensible defaults: Uses project-specific markdownlint configuration when present or a minimal default config to ensure predictable behavior.
  • Validation and auto-fix: Runs lint checks across files, reports rule-level failures with actionable fixes, and supports an optional auto-fix mode for common issues.
  • Use Case: Integrate into local development or CI to validate docs, enforce team style, and reduce back-and-forth in PR reviews.

Quick Start

Run the markdownlint skill to validate and optionally auto-fix all Markdown files in the repository.

Frequently Asked Questions about markdownlint

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

FAQPage Schema
How do I lint markdown files to enforce consistent documentation style?

You can lint markdown files by running validation against formatting standards to ensure consistent documentation style, automatically detecting project configuration or applying a minimal default config to report rule-level errors.

Can I automatically fix markdown formatting errors in my repository?

Yes, you can automatically fix markdown formatting errors by enabling the optional auto-fix mode, which resolves common style issues across README files and docs folders to prevent regressions and reduce noisy diffs.

Do I need to install markdownlint-cli via npm before validating documentation?

You do not need to pre-install markdownlint-cli via npm; the skill auto-installs the dependency when missing and provides clear remediation steps if the installation fails during documentation validation.

Why does markdown linting fail during CI checks and how can I prevent it?

Markdown linting fails during CI checks due to inconsistent documentation formatting, but you can prevent it by validating README files and docs folders against a stable rule set to catch style regressions before review.

What is the best way to maintain clean markdown documentation across a large project?

The best way to maintain clean markdown documentation is to validate files against formatting standards using project-specific configuration or sensible defaults, ensuring readable diffs and enforcing team style consistently.