Docusaurus

Docusaurus

When to Use This Skill

USE When

• Building documentation for open source projects
• Need React components in documentation
• Require multi-version documentation
• Need internationalized documentation
• Want blog functionality alongside docs
• Building developer portals
• Need fast, SEO-optimized static sites
• Want MDX for interactive examples

DON'T USE When

• Simple single-page documentation (use basic HTML)
• Python-specific API docs with autodoc (use Sphinx)
• No React experience and simple needs (use MkDocs)
• Need real-time collaborative editing (use GitBook)
• Building slide presentations (use Marp)

Prerequisites

Installation

# Create new Docusaurus project
npx create-docusaurus@latest my-website classic

# With TypeScript
npx create-docusaurus@latest my-website classic --typescript

cd my-website
npm start

System Requirements

• Node.js 18.0 or higher
• npm 8 or yarn 1.22+
• Git (for versioning features)

Version History

v1.0.0 (2026-01-17)

• Initial skill creation
• Project setup and configuration
• Documentation pages with MDX
• Blog functionality
• Sidebar configuration
• Theme customization
• Versioning setup
• Internationalization (i18n)
• Algolia search integration
• GitHub Pages deployment
• Best practices and troubleshooting

Sub-Skills

• 1. Project Structure (+3)
• Integration with TypeDoc (+1)
• 1. Documentation Structure (+2)
• Build Fails with Module Not Found (+6)

Sub-Skills

• 5. MDX and React Components
• 6. Admonitions (+1)
• What's New
• 8. Versioning (+5)
• Subsection (H3)
• Custom Homepage (+1)
• Related Resources