doc-validate-markdown

Validate Markdown formatting and style compliance with markdownlint.

18|5|Updated Nov 3, 2025

Search Tags:#linting #documentation #markdown #validation #style #quality #pre-commit

Ready to run

npx skills add https://github.com/mvillmow/ml-odyssey --skill doc-validate-markdown

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: doc-validate-markdown
Source: https://github.com/mvillmow/ml-odyssey/tree/main/.claude/skills/doc-validate-markdown
Command: npx skills add https://github.com/mvillmow/ml-odyssey --skill doc-validate-markdown

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires markdownlint-cli2.

What problem does it solve? This Skill prevents common Markdown formatting, link, and style errors, ensuring documentation is consistent and professional before it's committed. It automates the tedious process of manual review, saving time and reducing complexity.

Core Features & Use Cases:

Automated Linting: Uses markdownlint to check for a wide range of style and syntax issues, from line length to code block formatting.
Pre-commit Validation: Ideal for integrating into CI/CD pipelines or pre-commit hooks to catch errors early, ensuring only high-quality documentation is merged.
Use Case: Before submitting a pull request with documentation updates, use this skill to automatically identify and fix formatting issues. This ensures your docs are always pristine and compliant with project standards, letting you focus on content.

Quick Start: Use the doc-validate-markdown skill to validate all markdown files in the current directory.

Frequently Asked Questions about doc-validate-markdown

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

FAQPage Schema

How do I validate markdown formatting and style in my documentation?▼

Markdown validation checks for style and formatting issues like line length, code block formatting, trailing whitespace, and blank lines around blocks. This Skill uses markdownlint-cli2 to automatically identify violations, ensuring consistent, professional documentation before commits.

Can I integrate markdown linting into my CI/CD pipeline or pre-commit workflow?▼

Yes, this Skill integrates markdown linting as a pre-commit hook or CI step to catch formatting errors early. Configure rules via .markdownlint.yaml to enforce project standards and prevent non-compliant documentation from merging.

What markdown formatting rules does this validation enforce?▼

The Skill enforces language-tagged code blocks, maximum line length of 120 characters, no trailing whitespace, final newlines, and proper blank lines around blocks. Common errors like MD040, MD031, MD013, and MD022 are detected with guidance for correction.

How do I fix markdown linting errors in my documentation?▼

Run the validation to identify issues, then review the error codes and descriptions provided. Configure .markdownlint.yaml to adjust rules as needed, and reformat files to match requirements like line length and code block syntax.

Does markdown validation work with different documentation styles or project standards?▼

Yes, .markdownlint.yaml configuration allows customization of rules and thresholds to match your project's documentation standards, making the validation flexible across different teams and style guides.

What's the best way to ensure markdown quality across a documentation project?▼

Apply markdown validation as an automated check before commits and in CI/CD pipelines. This catches formatting issues early, reduces manual review overhead, and maintains consistent documentation quality across contributors.