onesoftqwq/docusaurus

简易Docusaurus Docker镜像

镜像概述

本Docker镜像提供了一个在Docker环境中运行的简易Docusaurus实例。Docusaurus是由Meta开发的静态站点生成器，专为构建现代化文档网站设计，支持Markdown语法、版本控制、搜索功能等。该镜像简化了Docusaurus的部署流程，无需本地配置Node.js环境，即可快速启动和运行文档网站。

核心功能与特性

• Docker化部署：基于官方Node.js镜像构建，确保环境一致性，避免依赖冲突
• 快速启动：一键启动Docusaurus开发服务器，支持实时预览文档修改
• 兼容性保障：基于官方Docusaurus版本构建，确保与最新特性兼容
• 可扩展性：支持通过挂载本地目录自定义文档内容和配置
• 轻量级：优化镜像大小，减少资源占用

使用场景与适用范围

• 个人开发者快速搭建技术文档网站
• 团队协作构建项目API文档、用户手册
• 开源项目创建官方文档站点
• 教育机构构建课程资料或教程网站
• 需要快速原型验证文档网站效果的场景

使用方法与配置说明

基本使用（docker run）

bash
# 启动Docusaurus开发服务器（默认端口3000）
docker run -d -p 3000:3000 --name docusaurus docker.xuanyuan.run/simple-docusaurus

# 挂载本地文档目录（自定义内容）
docker run -d -p 3000:3000 -v /path/to/your/docs:/app/docs --name docusaurus docker.xuanyuan.run/simple-docusaurus

Docker Compose配置

创建docker-compose.yml文件：

yaml
version: '3'
services:
  docusaurus:
    image: docker.xuanyuan.run/simple-docusaurus
    ports:
      - "3000:3000"
    volumes:
      - ./docs:/app/docs  # 本地文档目录
      - ./docusaurus.config.js:/app/docusaurus.config.js  # 自定义配置文件
    restart: unless-stopped

启动服务：

bash
docker-compose up -d

访问方式

启动后，通过浏览器访问 http://localhost:3000 即可查看文档网站。开发模式下，修改本地挂载的文档内容会实时反映到页面上。

环境变量配置

自定义配置

1. 挂载本地docusaurus.config.js文件覆盖默认配置：

   bash
   docker run -d -p 3000:3000 -v /path/to/docusaurus.config.js:/app/docusaurus.config.js docker.xuanyuan.run/simple-docusaurus
   

2. 挂载docs目录自定义文档内容：

   bash
   docker run -d -p 3000:3000 -v /path/to/your/docs:/app/docs docker.xuanyuan.run/simple-docusaurus
   

生产环境构建

如需构建静态文件用于生产部署，可进入容器执行构建命令：

bash
# 进入容器
docker exec -it docusaurus sh

# 构建静态文件
npm run build

# 构建后的文件位于 /app/build 目录，可挂载到宿主机
docker run -d -p 80:80 -v /path/to/your/build:/usr/share/nginx/html docker.xuanyuan.run/nginx