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

  • ⚡ Effortless automation - Transform your Markdown with auto-fixing that handles formatting, linking, and style consistency automatically
  • 📖 Professional documentation - Enforce consistent line breaks, clean up trailing spaces, and organize link definitions for enterprise-ready documentation
  • 🎯 Smart terminology management - Automatically convert specified words into inline code or clickable links based on your configuration
  • ⚙️ Highly customizable configuration - Fine-tune every aspect with granular rule options, word lists, ignore patterns, and flexible thresholds to match your exact requirements

Try it live: Check out the Online Demo to see the plugin in action!

📖 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).