Docusaurus — Documentation Sites Made Easy

Installation

pip install our-ai-tool

---

## Docusaurus Features

### Content in Markdown/MDX

```markdown
# API Reference

Our SDK supports these methods:

```python
from our_sdk import Client
client = Client(api_key="...")
result = client.chat("Hello!")

:::tip Pro Tip Use streaming for real-time responses. :::

import { Chart } from './components/Chart';

MDX lets you embed React components directly in Markdown.

### Built-in Features

| Feature | Description |
|---------|-------------|
| **Sidebar** | Auto-generated from file structure |
| **Search** | Algolia DocSearch or local search |
| **Versioning** | Multiple doc versions side-by-side |
| **i18n** | Built-in internationalization |
| **Blog** | Integrated blog engine |
| **Dark mode** | Automatic theme switching |
| **SEO** | Meta tags, sitemap, canonical URLs |
| **PWA** | Offline support |

### Doc Versioning

```bash
# Create a new version snapshot
npm run docusaurus docs:version 2.0

# Users can switch between v1.0 and v2.0 docs

Internationalization

# Add Chinese translation
npm run docusaurus write-translations -- --locale zh
# Translate files in i18n/zh/

Deployment

# Build static site
npm run build

# Deploy to GitHub Pages
npx docusaurus deploy

# Or: Vercel, Netlify, any static host

Used By 10K+ Projects

React, Jest, Babel, Prettier, Redux, Supabase, Electron, Tauri, Mermaid, and thousands more.

FAQ

Q: What is Docusaurus? A: Docusaurus is Meta's open-source documentation framework with 64,400+ GitHub stars. Write in Markdown/MDX, get a fast static site with search, versioning, i18n, and SEO.

Q: Why use Docusaurus for AI project docs? A: AI projects need clear API docs, tutorials, and examples. Docusaurus provides versioning (for API changes), MDX (for interactive demos), search, and SEO — all out of the box.

Q: Is Docusaurus free? A: Yes, open-source under MIT license.