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.
| Emoji | Compatibility |
|---|---|
| ✅ | Fully Compatible |
| ⚠️ | Partially Compatible |
| ❌ | Not Compatible |
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.
NOTE
You can find more information on using @eslint/markdown together with eslint-markdown in the Configurations chapter.
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 and @eslint/markdown.
🚧 This section is a work in progress 🚧
This section is currently under construction and will be updated soon.
Migrating from remark-lint
If you are a user of remark-lint, this section will guide you through migrating your existing configuration to eslint-markdown and @eslint/markdown.
🚧 This section is a work in progress 🚧
This section is currently under construction and will be updated soon.
Migrating from textlint
If you are a user of textlint, this section will guide you through migrating your existing configuration to eslint-markdown and @eslint/markdown.
🚧 This section is a work in progress 🚧
This section is currently under construction and will be updated soon.