markdownlint

Format, lint, and validate Markdown files with markdownlint-cli2.

3|1|Updated Jun 20, 2020

Search Tags:#code quality #linting #markdown #validation #formatting #style guide

Ready to run

npx skills add https://github.com/gmolveau/dotfiles --skill markdownlint-gmolveau

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: markdownlint
Source: https://github.com/gmolveau/dotfiles/tree/main/.ia/skills/markdownlint
Command: npx skills add https://github.com/gmolveau/dotfiles --skill markdownlint-gmolveau

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures your Markdown files are consistently formatted, syntactically correct, and adhere to project-specific style guidelines, preventing common errors and improving readability.

Core Features & Use Cases

Linting & Validation: Checks Markdown files against a comprehensive set of rules.
Auto-fixing: Automatically corrects many common formatting and syntax issues.
Configuration: Supports project-specific rules via configuration files.
Use Case: Automatically format all .md files in a project to enforce consistent list indentation and ensure code blocks always specify a language.

Quick Start

Use the markdownlint skill to automatically fix all markdown files in the current directory.

Frequently Asked Questions about markdownlint

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

FAQPage Schema

How do I automatically format and fix Markdown files in my project?▼

The markdownlint skill automatically formats and fixes Markdown files using markdownlint-cli2, correcting common syntax and formatting issues like list indentation and code block language specifications.

What is Markdown linting and why do I need it for code quality?▼

Markdown linting validates documents against comprehensive style rules to enforce consistent formatting and syntax correctness, preventing common errors and improving overall code quality and readability.

Can I enforce custom style guide rules for Markdown validation?▼

Yes, you can enforce custom Markdown validation rules by defining project-specific style guidelines in configuration files, which the linter reads to apply and auto-fix your formatting standards.

How do I ensure code blocks always specify a language in Markdown?▼

You can ensure code blocks specify a language in Markdown by running the markdownlint skill, which detects and auto-fixes formatting issues to enforce your project's style configuration.

Does this Markdown linter require any dependencies to run?▼

The Markdown linter requires no external dependencies to run, allowing you to directly format, lint, and validate Markdown files without needing additional environment setup.