markdown-lint

Validate Markdown files for formatting and rule compliance.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/neon-law-foundation/navigator --skill markdown-lint-neon-law-foundation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: markdown-lint
Source: https://github.com/neon-law-foundation/navigator/tree/main/.claude/skills/markdown-lint
Command: npx skills add https://github.com/neon-law-foundation/navigator --skill markdown-lint-neon-law-foundation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It catches Markdown formatting issues before they reach review, keeping documentation consistent and preventing avoidable CI failures.

Core Features & Use Cases

  • Lints Markdown files in a folder or workspace using the repository's own navigator CLI.
  • Applies the Markdown rule set, including common formatting checks and the 120-character line limit.
  • Useful for READMEs, docs pages, CLAUDE instructions, and blog content before committing changes.

Quick Start

Use the markdown-lint skill to validate the Markdown files in the target path and report any rule violations.

Frequently Asked Questions about markdown-lint

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

FAQPage Schema
How do I lint Markdown files before committing changes to my repository?

You can lint Markdown files in a folder or workspace by running a validation tool that checks formatting and rule compliance before commits. This catches formatting issues early, keeping repository documentation consistent and preventing avoidable CI failures.

What is the line length limit for validating README and documentation files?

A common Markdown line length limit used during validation is 120 characters. Enforcing this limit during documentation checks prevents line-length violations from failing CI pipelines or blocking code reviews.

Can I use CLI validation to check Markdown formatting in a docs directory?

Yes, you can run a CLI tool in markdown-only validation mode to check a docs directory. It applies repository exclusion overrides to target specific files and catches formatting violations across READMEs, blog content, and instruction files.

Does Markdown validation work for CLAUDE.md and other instruction files?

Yes, Markdown validation applies to CLAUDE.md instruction files as well as READMEs and docs pages. It checks these files against the repository's formatting rules to ensure consistent documentation before review.

Why does my documentation fail CI checks due to Markdown formatting violations?

Documentation often fails CI checks due to uncaught formatting violations like exceeding the 120-character line limit or breaking M-family rules. Running a local lint check before committing catches these issues early and prevents pipeline failures.

What is the best way to validate Markdown formatting across a repository?

The best way to validate Markdown across a repository is using an automated linting tool that applies consistent formatting rules. This ensures all documentation, from READMEs to blog content, meets the required standards before reaching review.