Skip to main content

eslint-plugin-docusaurus-2

Welcome to the documentation site for eslint-plugin-docusaurus-2.

This plugin is being built for Docusaurus repositories that need stronger linting around docs structure, Docusaurus conventions, and TypeDoc-integrated documentation workflows.

What is already stableโ€‹

  • package identity and plugin namespace
  • Flat Config preset surface
  • Docusaurus docs site scaffold
  • TypeDoc generation entrypoints
  • twenty-one shipped Docusaurus-specific rules across config validation, deprecated-config migration, config typing, link semantics, social-card image hygiene, sidebar hygiene, page-module routing, pages-plugin setup, and site-source CSS architecture

What is still in progressโ€‹

The plugin now ships a focused Docusaurus-specific rule set, including config validation, deprecated-config migration, config typing, sidebar hygiene, duplicate sidebar-doc protection, page-module routing checks, pages-plugin setup checks, and site-source CSS architecture checks.

The next iterations will expand beyond the current config, pages, sidebar, and site-source checks.

Where to startโ€‹