Docusaurus

项目简介

Docusaurus 是由 Facebook 开源的一个现代化静态站点生成器，专门用于构建文档网站。它基于 React 构建，支持 Markdown 和 MDX 格式，能够快速创建专业、可维护的文档站点。

主要特性

🚀 快速部署

• 静态生成 - 生成纯静态 HTML 文件，可部署到任何静态托管服务
• 增量构建 - 只重新构建更改的文件，加快构建速度
• 国际化支持 - 内置多语言支持，轻松创建多语言文档站点

📝 内容友好

• Markdown/MDX - 支持在 Markdown 中直接使用 React 组件
• 博客功能 - 内置博客系统，支持 RSS/Atom 订阅
• 版本管理 - 支持文档版本控制，方便管理不同版本的文档

🎨 可定制化

• 主题系统 - 提供经典主题，支持自定义主题
• 搜索集成 - 支持 Algolia 搜索集成
• 响应式设计 - 移动端友好的响应式布局

🔧 易于维护

• 基于 React - 使用熟悉的 React 生态进行扩展
• TypeScript - 完整的 TypeScript 支持
• 插件系统 - 丰富的插件生态，可扩展功能

技术栈

技术	用途
React	UI 框架
webpack	模块打包器
Markdown/MDX	内容格式
TypeScript	类型安全
Lodash	工具函数库

适用场景

• 开源项目文档 - GitHub 项目的官方文档站点
• 产品文档 - SaaS 产品或 API 的技术文档
• 知识库 - 团队内部知识管理系统
• 技术博客 - 结合文档和博客的内容站点

与同类工具对比

工具	优势	适用场景
Docusaurus	开箱即用、国际化好、版本管理	项目文档、产品文档
VuePress	Vue 生态、轻量	Vue 项目文档
GitBook	在线协作、编辑友好	团队知识库
MkDocs	Python 生态、简单	技术文档

快速开始

# 使用 npm 创建新项目
npx create-docusaurus@latest my-website classic

# 进入项目目录
cd my-website

# 启动开发服务器
npm start

# 构建生产版本
npm run build

项目结构

my-website/
├── blog/              # 博客文章
├── docs/              # 文档内容
├── i18n/              # 国际化文件
├── src/               # 自定义源码
│   ├── css/           # 自定义样式
│   ├── pages/         # 自定义页面
│   └── theme/         # 主题覆盖
├── static/            # 静态资源
├── docusaurus.config.ts  # 站点配置
└── sidebars.ts        # 侧边栏配置

官方资源

• 官网: https://docusaurus.io/
• GitHub: https://github.com/facebook/docusaurus
• 文档: https://docusaurus.io/docs
• 中文社区: https://docusaurus.io/zh-CN/docs

本站点使用情况

本知识站点 (https://www.html5zhan.com/) 使用 Docusaurus 构建，采用了以下特性：

• 多语言支持（中文）
• 文档版本管理
• 博客系统集成
• 自定义主题样式
• 工具页面和资源导航