Skip to main content

Presets

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

PresetSummary
๐ŸŸข minimalSmallest future-ready baseline.
๐Ÿ”ต configFocused config/theme/plugin rule set.
๐ŸŸก recommendedDefault starting point for most repositories.
๐Ÿ”ด strictStricter path for mature sites.
๐ŸŸฃ allEvery stable rule once the catalog expands.
๐Ÿงช experimentalFuture 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.

RuleFixPreset 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.

RuleFixConfig 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