docusaurus
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.
Best use case
docusaurus is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
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.
Teams using docusaurus should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/docusaurus/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How docusaurus Compares
| Feature / Agent | docusaurus | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
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.
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
SKILL.md Source
# 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)
Related Skills
baoyu-article-illustrator
Article illustrations: type × style × palette consistency.
vscode-extensions
VS Code productivity optimization with essential extensions, settings sync, profiles, keybindings, snippets, and workspace configuration
git-advanced
Advanced git workflows including rebase, worktrees, bisect, hooks, and monorepo patterns
docker
Complete Docker containerization patterns with multi-stage builds for development and production workflows
elite-frontend-ux
Create distinctive, production-grade frontend interfaces with expert-level UX design. Use when building SaaS dashboards, landing pages, marketing sites, React/Vue components, HTML/CSS layouts, or any web UI. Combines bold aesthetic direction with systematic design tokens, WCAG accessibility, conversion optimization, and Tailwind/React best practices. Produces polished, memorable interfaces that avoid generic AI aesthetics while meeting professional standards. type: reference
sphinx
Generate comprehensive Python documentation with Sphinx. Covers autodoc for API extraction, Napoleon for Google/NumPy docstrings, intersphinx for cross-references, and multiple output formats including HTML, PDF, and ePub.
pandoc
Universal document converter for transforming Markdown to PDF, DOCX, HTML, LaTeX, and 40+ other formats. Covers templates, filters, citations with BibTeX/CSL, and batch conversion automation scripts.
marp
Create professional Markdown-based slide presentations with Marp. Covers themes, directives, speaker notes, presenter view, and export to PDF, HTML, and PPTX formats. Includes VS Code integration, CLI usage, and CI/CD automation.
slack-api
Slack bot development and workspace automation using Web API, Events API, Socket Mode, and Block Kit for building interactive messaging applications
miro-api
Miro whiteboard automation using REST API v2 and Python SDK for creating boards, frames, shapes, connectors, and collaborative visual workflows
calendly-api
Calendly scheduling automation using REST API v2 for managing event types, availability, bookings, webhooks, and scheduling workflows
mkdocs
Build professional project documentation with MkDocs and Material theme. Covers site configuration, navigation, plugins, search optimization, versioning with mike, and deployment to GitHub Pages.