markdownlint
Configure, manage, and troubleshoot markdownlint in projects. Use when user wants to setup/install/configure markdownlint, add/remove/modify linting rules, fix markdown validation issues, customize .markdownlint.yaml, update ignore patterns, integrate with tools (Husky, CI), or troubleshoot markdown linting errors. Use even when user mentions markdown formatting problems, quality issues, or style consistency without explicitly saying "markdownlint".
How do I install this agent skill?
npx skills add https://github.com/perdolique/workflow --skill markdownlintIs this agent skill safe to install?
- Gen Agent Trust Hubpass
The skill provides comprehensive guidance for setting up and using markdownlint in Node.js projects. It follows standard industry practices for configuration, ignore patterns, and integration with CI/CD pipelines and git hooks. No malicious patterns were detected.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
- Runlayerpass
3/7 files flagged
What does this agent skill do?
Markdownlint
Package manager detection
Before any operation, detect which package manager the project uses:
-
Check for lock files:
pnpm-lock.yaml→ usepnpmyarn.lock→ useyarnpackage-lock.json→ usenpmbun.lockb→ usebun
-
Check
packageManagerfield in package.json:"packageManager": "pnpm@8.0.0" -
If no indicators, ask the user which package manager they prefer
Throughout this skill, commands use pnpm as examples. Replace with the detected package manager:
pnpm add -D→npm install --save-dev/yarn add -D/bun add -dpnpm run→npm run/yarn run/bun runpnpm install→npm install/yarn install/bun install
Operation selection guide
Read the reference matching the requested work:
| Operation | Reference |
|---|---|
| Installation, configuration files, scripts, and verification instructions | Setup |
| Rule names, codes, options, enabling, or disabling rules | Rules |
| Ignored files, folders, patterns, and checking exclusions | Ignoring |
| Diagnosing violations, automatic fixes, and remaining manual fixes | Fixing |
| Scripts, hooks, CI, and editor integration | Integration |
| Missing files, failed hooks, installation errors, or performance problems | Troubleshooting |
For a request spanning several operations, read the main reference first, then the related references needed to complete and verify the setup.
Quick reference: Common commands
# Install
pnpm add -D markdownlint markdownlint-cli
# Run linting
pnpm run lint:markdown
# Auto-fix issues
vpx markdownlint '**/*.md' --fix
# Lint specific file
vpx markdownlint README.md
# Lint specific directory
vpx markdownlint 'docs/**/*.md'
Quick reference: Config file basics
.markdownlint.yaml in project root:
$schema: ./node_modules/markdownlint/schema/markdownlint-config-schema.json
# Disable a rule
line-length: false
# Enable a rule
no-duplicate-heading: true
# Configure a rule
heading-style:
style: "atx"
.markdownlintignore in project root (gitignore syntax):
node_modules
dist/
build/
CHANGELOG.md
Default configuration philosophy
When setting up markdownlint, use this opinionated default configuration:
$schema: ./node_modules/markdownlint/schema/markdownlint-config-schema.json
line-length: false # Modern editors handle wrapping
Keep the standard rules enabled and disable line-length in this default configuration because:
- Modern editors and viewers handle text wrapping automatically
- Fixed line length creates unnecessary friction in most projects
- Semantic issues are more valuable to catch than presentation issues
Customize other rules when the user requests it or established project requirements call for it.
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/perdolique/workflow/markdownlint">View markdownlint on skillZs</a>