config
config is the focused preset for repositories that want Docusaurus config, themeConfig, navbar/footer, and plugin-setup enforcement without bringing in sidebar, page-module, or site-source architecture rules.
What it configures todayโ
config includes the Docusaurus rules that primarily target docusaurus.config.* and its nested plugin/theme configuration surfaces:
no-conflicting-config-link-content-propsno-conflicting-config-link-propsno-empty-config-link-destinationsno-empty-config-link-labelsno-conflicting-theme-config-metadata-keysno-conflicting-search-providersno-search-link-without-search-providerno-search-page-path-conflictno-conflicting-footer-html-item-propsno-deprecated-google-analyticsno-deprecated-future-experimental-fasterno-deprecated-future-experimental-storageno-deprecated-on-broken-markdown-linksno-empty-head-tagsno-duplicate-footer-column-titlesno-duplicate-footer-link-item-destinationsno-duplicate-footer-link-item-labelsno-duplicate-head-tagsno-duplicate-navbar-item-destinationsno-duplicate-i18n-localesno-unknown-i18n-locale-configsno-duplicate-navbar-item-labelsno-duplicate-plugin-pwa-head-tagsno-duplicate-theme-classic-custom-cssno-duplicate-theme-config-metadata-keysno-empty-footer-link-columnsno-ignored-site-validationsno-empty-navbar-dropdown-itemsno-empty-navbar-item-objectsno-empty-theme-classic-custom-cssno-empty-theme-config-metadatano-redundant-social-card-metadatano-svg-social-card-imageprefer-config-satisfiesprefer-href-for-external-linksprefer-head-tag-attributes-objectprefer-i18n-default-locale-firstprefer-theme-config-docsearchprefer-theme-config-metadata-name-for-twitter-tagsprefer-theme-config-metadata-property-for-og-tagsprefer-to-for-internal-linksrequire-config-link-contentrequire-config-link-destinationrequire-footer-link-column-itemsrequire-footer-link-column-titlerequire-head-tag-attributes-when-no-inner-htmlrequire-head-tag-tag-namerequire-theme-config-color-mode-objectrequire-theme-config-docsearch-configvalidate-theme-config-color-mode-default-modevalidate-theme-config-color-mode-switch-flagsno-conflicting-theme-config-color-mode-flagsrequire-theme-config-announcement-bar-idrequire-theme-classic-custom-css-files-existrequire-theme-classic-package-installedrequire-docusaurus-faster-package-installedvalidate-theme-config-announcement-bar-is-closeablerequire-base-url-issue-banner-enabledrequire-base-url-slashesrequire-i18n-default-locale-in-localesrequire-plugin-pwa-debugrequire-plugin-pwa-head-manifestrequire-plugin-pwa-head-theme-colorrequire-plugin-pwa-offline-mode-activation-strategiesrequire-navbar-doc-item-doc-idrequire-navbar-doc-sidebar-item-sidebar-idrequire-navbar-docs-version-item-torequire-navbar-dropdown-itemsrequire-navbar-dropdown-labelrequire-navbar-html-item-valuerequire-markdown-mermaid-when-theme-mermaid-enabledvalidate-navbar-item-positionrequire-pages-plugin-excludesrequire-plugin-pwa-setuprequire-site-config-fieldsrequire-site-url-originrequire-trailing-slash-explicitrequire-theme-live-codeblock-package-installedrequire-theme-mermaid-package-installedrequire-theme-search-algolia-package-installedrequire-search-provider-package-installedrequire-docsearch-ask-ai-assistant-idrequire-rspack-bundler-for-faster-persistent-cacherequire-v4-remove-legacy-post-build-head-attribute-for-ssg-worker-threads
Flat config exampleโ
import docusaurus2 from "eslint-plugin-docusaurus-2";
export default [docusaurus2.configs.config];
When to use itโ
Use config when you want a focused Docusaurus config-and-theme baseline without pulling in sidebar-only rules or the broader page/CSS architecture rules from strict.