Introduction

As of October 3, 2024, ESLint officially supports linting Markdown. The ESLint team stated that this is just the first step toward building a language-agnostic platform for source code linting.

This project aims to align with this trend by providing various rules to improve the quality of Markdown documents, with support for CommonMark and GitHub Flavored Markdown (GFM).

Simply lint your Markdown files using the same tool you use for JavaScript, TypeScript, and other source code files.

Goal

Our goal is to provide a set of ESLint rules that help you write better Markdown documents and make it easy to migrate from popular Markdown linters such as markdownlint, remark-lint, and textlint. (You can find additional details in the Migration Guide.)

By combining this eslint-markdown plugin with ESLint's built-in Markdown support @eslint/markdown, you can lint both your code and documentation with a single tool.

🦄

I hope this plugin becomes a unicorn for Markdown linting that everyone loves someday. 😄

Limitations

This plugin does not include any rules that overlap with ESLint's built-in Markdown rules provided by @eslint/markdown. As a result, eslint-markdown is completely disjoint from @eslint/markdown.

If the upstream @eslint/markdown project adopts any rules from this plugin, we will deprecate and remove the overlapping rules in this plugin.