What problem does it solve?
Markdown and MDX files in large docs repositories often suffer from inconsistent formatting, trailing spaces, and rule violations that stall reviews. This Skill automates formatting and linting to enforce best practices and reduce manual cleanup.
Core Features & Use Cases
- Automated Formatting: Apply consistent Markdown styles across your docs using markdownlint rules.
- Linting & Fixes: Detect and auto-fix common issues (MD001, MD013, MD033, etc.) to improve readability and quality.
- Documentation Standards: Helps maintain uniform docs in team projects and CI pipelines, saving time in code review.
- Use Case: When you have a large docs repository with MDX files, run this Skill to automatically fix formatting and surface lingering issues for review.
Quick Start
Install markdownlint if needed:
- pnpm add -D markdownlint
- or npm install -g markdownlint
Then run:
- markdownlint --fix "**/*.{md,mdx}"
- markdownlint README.md docs//*.md content//*.mdx