| name | markdownlint |
| description | Validate markdown files against formatting standards. Auto-detects and installs markdownlint-cli if missing. Checks project config or falls back to sensible defaults. Supports auto-fix mode. Use when creating or modifying markdown files, validating documentation, or enforcing markdown conventions.
|
| compatibility | Requires Node.js (npx). Works with any project containing markdown files.
|
Markdownlint
Validate markdown files follow formatting standards. Enables consistent
documentation, readable diffs, and POSIX compliance.
What this skill does
- Checks if
markdownlint-cli is installed; installs if missing.
- Detects project-specific markdownlint configuration or falls back to a
minimal default config.
- Validates markdown files for formatting, structure, and style.
- Optionally auto-fixes common issues with
--fix flag; reports errors
with specific rules and fixes.
Installation check
markdownlint --version 2>/dev/null
If not installed, install globally:
npm install -g markdownlint-cli
If installation fails (permissions, no npm), stop validation and report
the issue with remediation steps:
- Use
sudo npm install -g ... or fix npm permissions
- Use a Node version manager (nvm, volta, fnm)
- Install Node.js if not present
Do not silently skip validation.
Config detection priority