Skip to content

Introduction ​

A specialized ESLint plugin that helps enforce consistent writing style and formatting conventions in Markdown files. Perfect for documentation projects, blog posts, and any Markdown content where consistency matters.

NPM licenseNPM versionNPM downloadsNPM downloadsNPM downloadsNPM downloadsNPM downloadsBuild Status

πŸ“› Features ​

  • πŸ“ Comprehensive style enforcement Enforces consistent heading casing, table header casing, inline code/link usage, emoji notation, and more for unified document style.
  • 🧩 Powerful formatting consistency Strongly standardizes Markdown formatting: whitespace, indentation, spacing, line breaks, list markers, code fences, links, references, thematic breaks, tables, and decorative elementsβ€”ensuring documents are clean and uniform.
  • πŸš€ Extended Markdown syntax support Supports custom containers, mathematical expressions, and other extended syntax for high compatibility with VitePress.
  • πŸ”§ Auto-fix support Most rules support ESLint's --fix option for automatic correction.
  • 🌐 Online Demo & Documentation Try it instantly in the Online Demo and see full documentation.

πŸ“– Usage ​

See User Guide.

βœ… Rules ​

See Available Rules.

🍻 Contributing ​

Welcome contributing!

Please use GitHub's Issues/PRs.

Development Tools ​

  • npm test runs tests and measures coverage.
  • npm run update runs in order to update readme and recommended configuration.

πŸ”’ License ​

See the LICENSE file for license rights and limitations (MIT).