๐
Get Started
Install the package, pick a preset, and understand what the plugin guarantees immediately.
Open section๐ Start here
Pick the entry point that matches how you want to adopt the plugin: quick-start docs, the full rule catalog, preset guidance, or the maintainer-facing architecture docs.
๐
Rule Reference
Browse the hand-authored rule docs, rationale, and examples across the full Docusaurus rule catalog.
Open section๐ ๏ธ
Preset Guide
Compare minimal, config, recommended, strict, and the broader rollout tiers with a linked preset matrix.
Open section๐งฐ
Maintainer Docs
Understand the docs app, generated API pages, site contract, and validation pipeline as a maintainer.
Open section๐งญ What the plugin covers
The rule catalog is intentionally centered on the pain points unique to Docusaurus repositories: config shape, themeConfig semantics, sidebars, site-source boundaries, and TypeDoc-adjacent docs workflows.
โ๏ธ
Config & theme rules
Top-level site config, deployment fields, plugin-pwa setup, validation severities, and theme-config metadata rules.
Explore rules๐งญ
Sidebar & docs navigation
Sidebar category shape, category links, generated-index/doc semantics, duplicate doc assignment, and collapse-state hygiene.
Explore rules๐จ
Site-source architecture
Component link semantics, page module contracts, CSS boundaries, and static asset usage for mature docs sites.
Explore rules