Migration Guide

This chapter provides guidance for migrating to @eslint/markdown and eslint-markdown from other Markdown linting tools like markdownlint, remark-lint, and textlint.

Migrating from @eslint/markdown

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, and no migration is needed.

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

You can use both @eslint/markdown and eslint-markdown together to get full support and additional features when migrating your Markdown linting setup, which is covered in the following section.

Migrating from markdownlint

If you are a user of markdownlint, markdownlint-cli, or markdownlint-cli2, this section will guide you through migrating your existing configuration to eslint-markdown.

TODO

Migrating from remark-lint

TODO

Migrating from textlint

TODO