Presets

eslint-plugin-docusaurus-2 exposes a focused flat-config preset ladder:

Preset	Summary
🟢 minimal	Smallest future-ready baseline.
🔵 config	Focused config/theme/plugin rule set.
🟡 recommended	Default starting point for most repositories.
🔴 strict	Stricter path for mature sites.
🟣 all	Every stable rule once the catalog expands.
🧪 experimental	Future experimental rule candidates.

Use the matrix below to quickly compare rule coverage and pick the strictness tier that fits your docs repository.

The plugin also exports opt-in content configs outside this preset ladder:

• docusaurus2.configs.content
• docusaurus2.configs["strict-mdx-upgrade"]

Rule matrix

The current rule catalog focuses on Docusaurus config, validation, sidebar, and site-source CSS correctness.

The public preset surface is stable, and the rule catalog is intentionally focused while higher-value Docusaurus rule gaps are explored.

• Fix legend:
  • 🔧 = autofixable
  • 💡 = suggestions available
  • — = report only
• Rules shown without preset membership appear in the opt-in rules table below.
• Preset key legend:
  • 🟢 — docusaurus2.configs.minimal
  • 🔵 — docusaurus2.configs.config
  • 🟡 — docusaurus2.configs.recommended
  • 🔴 — docusaurus2.configs.strict
  • 🟣 — docusaurus2.configs.all
  • 🧪 — docusaurus2.configs.experimental

Rule	Fix	Preset key
no-conflicting-config-link-content-props	—	🔵 🟡 🔴 🟣 🧪
no-conflicting-config-link-props	🔧	🔵 🟡 🔴 🟣 🧪
no-conflicting-footer-html-item-props	—	🔵 🟡 🔴 🟣 🧪
no-conflicting-navbar-doc-item-props	🔧	🔵 🟡 🔴 🟣 🧪
no-conflicting-navbar-doc-sidebar-item-props	🔧	🔵 🟡 🔴 🟣 🧪
no-conflicting-search-providers	—	🔵 🟡 🔴 🟣 🧪
no-conflicting-theme-config-color-mode-flags	🔧	🔵 🔴 🟣 🧪
no-conflicting-theme-config-metadata-keys	💡	🔵 🔴 🟣 🧪
no-deprecated-future-experimental-faster	🔧	🔵 🟡 🔴 🟣 🧪
no-deprecated-future-experimental-storage	🔧	🔵 🟡 🔴 🟣 🧪
no-deprecated-google-analytics	💡	🔵 🟡 🔴 🟣 🧪
no-deprecated-on-broken-markdown-links	🔧	🔵 🟡 🔴 🟣 🧪
no-duplicate-footer-column-titles	—	🔵 🔴 🟣 🧪
no-duplicate-footer-link-item-destinations	💡	🔵 🔴 🟣 🧪
no-duplicate-footer-link-item-labels	—	🔵 🔴 🟣 🧪
no-duplicate-head-tags	🔧	🔵 🔴 🟣 🧪
no-duplicate-i18n-locales	🔧 💡	🔵 🔴 🟣 🧪
no-duplicate-navbar-item-destinations	💡	🔵 🔴 🟣 🧪
no-duplicate-navbar-item-labels	—	🔵 🔴 🟣 🧪
no-duplicate-plugin-pwa-head-tags	🔧	🔵 🔴 🟣 🧪
no-duplicate-sidebar-doc-ids	💡	🔴 🟣 🧪
no-duplicate-theme-classic-custom-css	🔧	🔵 🟡 🔴 🟣 🧪
no-duplicate-theme-config-metadata-keys	🔧	🔵 🔴 🟣 🧪
no-empty-config-link-destinations	🔧	🔵 🟡 🔴 🟣 🧪
no-empty-config-link-labels	🔧	🔵 🟡 🔴 🟣 🧪
no-empty-footer-link-columns	🔧	🔵 🔴 🟣 🧪
no-empty-footer-link-items	🔧	🔵 🔴 🟣 🧪
no-empty-head-tags	🔧	🔵 🔴 🟣 🧪
no-empty-navbar-dropdown-items	🔧	🔵 🟡 🔴 🟣 🧪
no-empty-navbar-item-objects	🔧	🔵 🔴 🟣 🧪
no-empty-sidebar-categories	🔧	🟡 🔴 🟣 🧪
no-empty-theme-classic-custom-css	🔧	🔵 🟡 🔴 🟣 🧪
no-empty-theme-config-metadata	🔧	🔵 🔴 🟣 🧪
no-ignored-site-validations	🔧	🔵 🟡 🔴 🟣 🧪
no-mixed-sidebar-link-kinds	💡	🔴 🟣 🧪
no-page-css-module-imports-in-components	—	🔴 🟣 🧪
no-redundant-social-card-metadata	🔧	🔵 🔴 🟣 🧪
no-search-link-without-search-provider	—	🔵 🟡 🔴 🟣 🧪
no-search-page-link-when-search-page-disabled	—	🔵 🟡 🔴 🟣 🧪
no-search-page-path-conflict	—	🔵 🟡 🔴 🟣 🧪
no-svg-social-card-image	—	🔵 🟡 🔴 🟣 🧪
no-unknown-i18n-locale-configs	—	🔵 🟡 🔴 🟣 🧪
no-use-base-url-for-internal-link-components	🔧	🟡 🔴 🟣 🧪
no-useless-collapsed-sidebar-categories	🔧	🟡 🔴 🟣 🧪
prefer-config-satisfies	🔧	🔵 🟡 🔴 🟣 🧪
prefer-css-modules-in-site-src	—	🔴 🟣 🧪
prefer-head-tag-attributes-object	🔧	🔵 🔴 🟣 🧪
prefer-href-for-external-link-components	🔧	🟡 🔴 🟣 🧪
prefer-href-for-external-links	🔧	🔵 🟡 🔴 🟣 🧪
prefer-i18n-default-locale-first	🔧 💡	🔵 🔴 🟣 🧪
prefer-sidebars-config-satisfies	🔧	🟡 🔴 🟣 🧪
prefer-theme-config-docsearch	🔧	🔵 🟡 🔴 🟣 🧪
prefer-theme-config-metadata-name-for-twitter-tags	🔧	🔵 🔴 🟣 🧪
prefer-theme-config-metadata-property-for-og-tags	🔧	🔵 🔴 🟣 🧪
prefer-to-for-internal-link-components	🔧	🟡 🔴 🟣 🧪
prefer-to-for-internal-links	🔧	🔵 🟡 🔴 🟣 🧪
prefer-use-base-url-for-static-assets	💡	🔴 🟣 🧪
require-base-url-issue-banner-enabled	🔧	🔵 🔴 🟣 🧪
require-base-url-slashes	🔧	🔵 🔴 🟣 🧪
require-config-link-content	—	🔵 🟡 🔴 🟣 🧪
require-config-link-destination	—	🔵 🟡 🔴 🟣 🧪
require-default-export-pages	—	🔴 🟣 🧪
require-doc-sidebar-link-type	🔧	🟡 🔴 🟣 🧪
require-docsearch-ask-ai-assistant-id	—	🔵 🟡 🔴 🟣 🧪
require-docsearch-theme-when-configured	—	🔵 🟡 🔴 🟣 🧪
require-docusaurus-faster-package-installed	—	🔵 🟡 🔴 🟣 🧪
require-footer-link-column-items	—	🔵 🟡 🔴 🟣 🧪
require-footer-link-column-title	—	🔵 🟡 🔴 🟣 🧪
require-generated-index-link-type	🔧	🟡 🔴 🟣 🧪
require-head-tag-attributes-when-no-inner-html	—	🔵 🔴 🟣 🧪
require-head-tag-content-or-attributes	—	🔵 🔴 🟣 🧪
require-head-tag-tag-name	💡	🔵 🔴 🟣 🧪
require-i18n-default-locale-in-locales	🔧 💡	🔵 🔴 🟣 🧪
require-markdown-mermaid-when-theme-mermaid-enabled	🔧	🔵 🟡 🔴 🟣 🧪
require-navbar-doc-item-doc-id	—	🔵 🟡 🔴 🟣 🧪
require-navbar-doc-sidebar-item-sidebar-id	—	🔵 🟡 🔴 🟣 🧪
require-navbar-docs-version-item-to	—	🔵 🟡 🔴 🟣 🧪
require-navbar-dropdown-items	—	🔵 🟡 🔴 🟣 🧪
require-navbar-dropdown-label	—	🔵 🟡 🔴 🟣 🧪
require-navbar-html-item-value	—	🔵 🟡 🔴 🟣 🧪
require-pages-plugin-excludes	🔧	🔵 🔴 🟣 🧪
require-plugin-pwa-debug	—	🔵 🔴 🟣 🧪
require-plugin-pwa-head-manifest	—	🔵 🟡 🔴 🟣 🧪
require-plugin-pwa-head-theme-color	—	🔵 🟡 🔴 🟣 🧪
require-plugin-pwa-offline-mode-activation-strategies	—	🔵 🔴 🟣 🧪
require-plugin-pwa-setup	—	🔵 🔴 🟣 🧪
require-rspack-bundler-for-faster-persistent-cache	🔧	🔵 🟡 🔴 🟣 🧪
require-search-provider-package-installed	—	🔵 🟡 🔴 🟣 🧪
require-sidebar-category-items	—	🟡 🔴 🟣 🧪
require-sidebar-category-label	—	🟡 🔴 🟣 🧪
require-sidebar-category-type	🔧	🟡 🔴 🟣 🧪
require-sidebar-item-key-for-duplicate-labels	—	🔴 🟣 🧪
require-site-config-fields	—	🔵 🔴 🟣 🧪
require-site-url-origin	🔧 💡	🔵 🔴 🟣 🧪
require-theme-classic-custom-css-files-exist	—	🔵 🟡 🔴 🟣 🧪
require-theme-classic-package-installed	—	🔵 🟡 🔴 🟣 🧪
require-theme-config-announcement-bar-id	—	🔵 🔴 🟣 🧪
require-theme-config-color-mode-object	💡	🔵 🔴 🟣 🧪
require-theme-config-docsearch-config	—	🔵 🟡 🔴 🟣 🧪
require-theme-config-image	—	🔵 🔴 🟣 🧪
require-theme-live-codeblock-package-installed	—	🔵 🟡 🔴 🟣 🧪
require-theme-live-codeblock-when-live-codeblock-configured	💡	🔵 🟡 🔴 🟣 🧪
require-theme-mermaid-package-installed	—	🔵 🟡 🔴 🟣 🧪
require-theme-mermaid-when-markdown-mermaid-enabled	💡	🔵 🟡 🔴 🟣 🧪
require-theme-search-algolia-package-installed	—	🔵 🟡 🔴 🟣 🧪
require-trailing-slash-explicit	🔧 💡	🔵 🔴 🟣 🧪
require-v4-remove-legacy-post-build-head-attribute-for-ssg-worker-threads	🔧	🔵 🟡 🔴 🟣 🧪
validate-live-codeblock-playground-position	💡	🔵 🟡 🔴 🟣 🧪
validate-navbar-item-position	🔧 💡	🔵 🔴 🟣 🧪
validate-theme-config-announcement-bar-is-closeable	🔧 💡	🔵 🔴 🟣 🧪
validate-theme-config-color-mode-default-mode	🔧 💡	🔵 🔴 🟣 🧪
validate-theme-config-color-mode-switch-flags	🔧 💡	🔵 🔴 🟣 🧪
validate-theme-config-footer-style	🔧 💡	🔵 🔴 🟣 🧪
validate-theme-config-metadata	—	🔵 🟡 🔴 🟣 🧪
validate-theme-config-navbar-style	🔧 💡	🔵 🔴 🟣 🧪

Opt-in rules

These rules are intentionally outside the preset ladder. Some are enabled through opt-in content configs; others are direct rule opt-ins only.

• Config surface legend:
  • 📝 — docusaurus2.configs.content
  • 🧭 — docusaurus2.configs["strict-mdx-upgrade"]

Rule	Fix	Config surface
local-search-will-not-work-in-dev	—	direct rule opt-in only
no-deprecated-admonition-title-syntax	🔧	📝 docusaurus2.configs.content 🧭 docusaurus2.configs["strict-mdx-upgrade"]
no-deprecated-heading-id-syntax	🔧	📝 docusaurus2.configs.content 🧭 docusaurus2.configs["strict-mdx-upgrade"]
no-deprecated-html-comments-in-mdx	🔧	📝 docusaurus2.configs.content 🧭 docusaurus2.configs["strict-mdx-upgrade"]
require-mermaid-elk-package-installed	—	📝 docusaurus2.configs.content