# Docusaurus — Documentation Sites Made Easy

> Build fast, SEO-friendly documentation websites with React and Markdown. By Meta. Powers 10K+ sites. 64K+ GitHub stars.

## Install

Copy the content below into your project:

# Docusaurus — Documentation Sites Made Easy

## Quick Use

```bash
npx create-docusaurus@latest my-docs classic
cd my-docs
npm start
```

Open `http://localhost:3000` — your docs site is live with hot reload.

Add a new doc page:
```markdown
<!-- docs/getting-started.md -->
---
sidebar_position: 1
---

# Getting Started

Welcome to our AI tool documentation.

## Installation

```bash
pip install our-ai-tool
```
```

---

## Intro

Docusaurus is Meta's open-source documentation framework with 64,400+ GitHub stars, powering documentation sites for React, Jest, Babel, Prettier, and 10,000+ other projects. Write content in Markdown or MDX (Markdown + React components), and Docusaurus generates a fast, SEO-optimized static site with search, versioning, i18n, and dark mode. For AI projects, it's the standard for creating professional documentation — from API references to tutorials to knowledge bases. Deploy anywhere: Vercel, Netlify, GitHub Pages, or any static host.

Works with: React, Markdown/MDX, Algolia Search, GitHub Pages, Vercel, Netlify. Best for open-source projects and AI tools that need professional documentation. Setup time: under 2 minutes.

---

## 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';
<Chart data={perfData} />
```

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

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

### Deployment

```bash
# 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.

---

## Source & Thanks

> Created by [Meta](https://github.com/facebook). Licensed under MIT.
>
> [docusaurus](https://github.com/facebook/docusaurus) — ⭐ 64,400+

---

<!-- ZH -->

## 快速使用

```bash
npx create-docusaurus@latest my-docs classic
cd my-docs && npm start
```

---

## 简介

Docusaurus 是 Meta 开源的文档框架，拥有 64,400+ GitHub stars。用 Markdown/MDX 写内容，生成快速、SEO 优化的静态网站，内置搜索、版本管理和多语言支持。

---

## 来源与感谢

> Created by [Meta](https://github.com/facebook). Licensed under MIT.
>
> [docusaurus](https://github.com/facebook/docusaurus) — ⭐ 64,400+


---
Source: https://tokrepo.com/en/workflows/2c489776-4de1-435c-a5a7-15b33e34efeb
Author: AI Open Source