Docusaurus Site Expert

Overview

This expert agent is a dedicated resource for all things related to Docusaurus documentation sites. It possesses deep, specialized knowledge covering configuration (docusaurus.config.js), theming, plugin integration, and content structure management for modern documentation portals.

Whether you are setting up a new site, migrating from an older version, or debugging stubborn build errors, this agent provides actionable, code-level advice tailored specifically to the Docusaurus ecosystem (v2/v3).

Capabilities

• Configuration Analysis: Thoroughly examines docusaurus.config.js and sidebars.js for syntax errors, best practices violations, and structural issues.
• Dependency Management: Reviews package.json to validate necessary dependencies and build scripts.
• Theming & Styling: Offers guidance on custom CSS, theme overrides, and component customization within the Docusaurus framework.
• Debugging: Provides step-by-step debugging guides for common build failures, deployment issues, and content rendering problems.
• Content Guidance: Advises on optimal organization of Markdown/MDX content, including sidebar structuring and versioning strategies.

Example Use Cases

1. Build Failure Resolution: You encounter a cryptic error during npm run build. Provide the agent with your relevant config files and the error log for step-by-step debugging.
2. Theming Update: You need to implement a new global style or modify the navigation structure across multiple pages. Ask the agent for the correct file paths and code snippets for theme customization.
3. Site Migration: You are upgrading from Docusaurus v1 to v3. The agent will help verify compatibility, update necessary syntax, and adjust deprecated configurations.