meumouse/docusaurus

Docusaurus 3.5.1 经典主题文档系统

概述

Docusaurus 3.5.1 经典主题（theme classic）是一个基于React的静态站点生成器，专为构建高质量技术文档网站设计。该镜像包含Docusaurus 3.5.1核心功能及经典主题，提供开箱即用的文档网站解决方案，支持快速搭建结构清晰、视觉统一的文档平台。

核心功能与特性

• Markdown原生支持：直接使用Markdown编写文档，支持GFM语法及扩展功能
• 响应式设计：自动适配桌面、平板和移动设备，提供一致的浏览体验
• 多语言支持：内置国际化功能，轻松实现文档多语言版本管理
• 经典主题组件：包含导航栏、侧边栏、目录、页脚等预定义UI组件
• 内置搜索：集成Algolia搜索或本地搜索功能，快速定位文档内容
• 版本控制：支持文档版本管理，可维护多个文档版本并行发布
• 热重载开发：开发模式下实时预览文档变更，加速内容创作流程

使用场景

• 技术产品API文档网站构建
• 开源项目文档站点部署
• 企业内部知识库搭建
• 软件用户手册发布平台
• 技术教程与培训材料展示

使用方法与配置

基本部署（Docker Run）

bash
docker run -d \
  -p 3000:3000 \
  -v $(pwd)/docs:/:/app/app/docs \
  -v $(pwd)/docusaurus.config.js:/app/docusaurusaurus.config.js \/docusaurus:3.5.1-theme-classic

说明：映射本地docs目录存放文档内容，docusaurus.config.js为配置文件，容器暴露3000端口提供访问

Docker Compose配置

yaml
version: '3'
services:
  docusaurus:
    image:: 镜像名称:3.5.1-theme-classic
    ports:
      - "3000:3000"
    volumes:
      - ./docs:/app/docs
      - ./docusaurus.config.js:/app/docusaurus.config.js
      - ./src:/app/src  # 自定义组件目录
      - ./static:/app/static  # 静态资源目录
    restart: unless-stopped

核心配置说明

配置文件（docusaurus.config.js）

主要配置项包括：

• title：网站标题
• tagline：网站副标题
• url：网站基础URL
• baseUrl：网站基础路径
• onBrokenLinks：链接错误处理策略
• themeConfig：经典主题具体配置（导航栏、侧边栏、颜色方案等）

文档目录结构

docs/
├── intro.md          # 首页文档
├── tutorial-basics/  # 文档分类目录
│   ├── _category_.json  # 分类配置
│   ├── create-a-page.md
│   └── ...
└── ...

开发与构建模式

• 开发模式：容器默认启动开发服务器，支持热重载
• 生产构建：通过环境变量NODE_ENV=production触发静态文件构建，输出至build目录

注意事项

• 首次启动需等待依赖安装完成
• 自定义主题需映射src/theme目录覆盖默认组件
• 生产环境建议配合Nginx等反向代理使用，提升性能与安全性