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.
π 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.
π« Related Packages β
- eslint-plugin-markdown-links ... ESLint plugin with powerful checking rules related to Markdown links.
π» 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).