markdownlint

name

markdownlint

description

Ensures style consistency and correctness in Markdown files using markdownlint-cli2. Use whenever creating, updating, editing, or reviewing any Markdown (.md) file. Triggers on any task that creates or modifies .md files, including README.md, CHANGELOG.md, documentation, or any file with a .md extension. Also triggers when the user mentions markdown, linting, markdown formatting, markdown style, or markdownlint. Always run the linter after writing or editing markdown content — do not skip this step.

Markdownlint

Lint Markdown files for style and consistency using markdownlint via the markdownlint-cli2 CLI.

Running the linter

Lint specific files or directories:

npx markdownlint-cli2 "docs/**/*.md"

Lint and auto-fix fixable issues:

npx markdownlint-cli2 --fix "docs/**/*.md"

Lint multiple paths:

npx markdownlint-cli2 "docs/**/*.md" "README.md" "CHANGELOG.md"

Exclude paths with # (negation):

npx markdownlint-cli2 "**/*.md" "#node_modules"

Exit codes

• 0: No errors (warnings may exist)
• 1: Linting errors found
• 2: Linting failed (e.g., bad config)

Interpreting output

Output format: filepath:line rule/alias description

Example: