Docusaurus

---
name: docusaurus
description: Build modern documentation websites with Docusaurus. Covers docs, blog,
  pages, versioning, i18n, search integration, and deployment patterns. React-based
  with MDX support for interactive documentation.
version: 1.0.0
category: development
type: skill
capabilities:
- React-based documentation sites
- MDX for interactive content
- Docs, blog, and pages
- Multi-version documentation
- Internationalization (i18n)
- Algolia DocSearch integration
- Plugin ecosystem
- Theme customization
- SEO optimization
- GitHub Pages deployment
tools:
- docusaurus
- node
- npm
- react
- mdx
- algolia
tags:
- documentation
- react
- static-site
- mdx
- versioning
- i18n
- search
platforms:
- linux
- macos
- windows
related_skills:
- mkdocs
- sphinx
---

# 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

```bash
# 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)](1-project-structure/SKILL.md)
- [Integration with TypeDoc (+1)](integration-with-typedoc/SKILL.md)
- [1. Documentation Structure (+2)](1-documentation-structure/SKILL.md)
- [Build Fails with Module Not Found (+6)](build-fails-with-module-not-found/SKILL.md)

## Sub-Skills

- [5. MDX and React Components](5-mdx-and-react-components/SKILL.md)
- [6. Admonitions (+1)](6-admonitions/SKILL.md)
- [What's New](whats-new/SKILL.md)
- [8. Versioning (+5)](8-versioning/SKILL.md)
- [Subsection (H3)](subsection-h3/SKILL.md)
- [Custom Homepage (+1)](custom-homepage/SKILL.md)
- [Related Resources](related-resources/SKILL.md)