remarklint
A collection of remark plugins to lint and enforce consistent Markdown code style.
What is remarklint?
remark-lint is a collection of plugins for the remark Markdown processor that checks Markdown files for style consistency, common mistakes, and cross-parser compatibility. It helps automate the enforcement of Markdown code standards, ensuring documentation is clean, consistent, and less prone to errors.
Developers and technical writers who author documentation in Markdown and need to maintain consistent style across teams or projects, especially those using the remark ecosystem.
It offers a highly extensible, rule-based approach integrated directly into the remark toolchain, with fine-grained control and the ability to create custom rules, unlike generic Markdown validators.
Overview
plugins to check (lint) markdown code style
Use Cases
Best For
- Enforcing consistent Markdown style guides across documentation repositories
- Automating code review checks for Markdown files in CI/CD pipelines
- Maintaining cross-parser compatibility for Markdown rendered on different platforms
- Teaching Markdown best practices to new contributors
- Integrating Markdown linting into editor workflows (VS Code, Sublime, Vim)
- Creating custom Markdown linting rules for project-specific requirements
Not Ideal For
- Projects using non-remark Markdown processors like Pandoc or static site generators without unified integration
- Teams wanting out-of-the-box auto-fix functionality without manual synchronization between linting and formatting settings
- Developers seeking a lightweight, standalone linter with zero configuration for quick, one-off checks
- Environments requiring real-time, as-you-type linting in editors without build step integrations
Pros & Cons
Pros
Offers over 70 granular rules, such as ordered-list-marker-style and emphasis-marker, covering specific aspects from whitespace to cross-parser compatibility, as detailed in the README's rules list.
Supports configurable presets like remark-preset-lint-recommended, inline control via HTML comments to disable/enable rules, and custom rule creation, allowing tailored linting workflows.
Seamlessly works with remark's API, CLI, and editor integrations (VS Code, Sublime, Vim), making it easy to embed in existing development pipelines, as highlighted in the Integrations section.
Uses warnings instead of errors to avoid blocking processing, enabling continuous checks and formatting, which is explicitly noted in the Configure section for maintaining workflow flexibility.
Cons
Syncing lint rules with remark-stringify formatting settings is manual and error-prone, requiring separate configuration steps, as shown in the 'check and format' examples where users must duplicate settings.
Deeply tied to the unified/remark ecosystem, limiting its usefulness for projects using alternative Markdown toolchains, and requiring familiarity with mdast for custom rule development.
While it checks for issues, automatic fixes require coupling with remark's formatting, which isn't integrated by default—users must manually handle corrections, adding overhead compared to all-in-one linters.
Frequently Asked Questions
Related Projects
Vale:pencil: A markup-aware linter for prose built with speed and extensibility in mind.
write-goodNaive linter for English prose
proselintA linter for prose.
Markdown lint toolMarkdown lint tool
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.