husnibakri/docusaurus

Docusaurus文档站点镜像

镜像概述

本镜像基于nginx:latest构建，集成Node.js 14.x环境，预配置Docusaurus文档框架，可快速部署静态文档网站。通过Nginx提供文档访问服务，包含完整的文档构建流程，适用于技术文档、产品手册、知识库等场景的快速搭建。

核心功能与特性

• 环境集成：包含Nginx服务和Node.js 14.x运行环境，满足文档构建与访问需求
• Docusaurus预配置：已初始化Docusaurus项目（使用***模板），项目路径为/usr/share/nginx/html/docu
• Nginx配置优化：默认Nginx根目录已指向Docusaurus构建产物路径（/usr/share/nginx/html/docu/build）
• 多端口支持：暴露80（Nginx服务）、3000（Docusaurus开发服务器）、35729（热重载）端口

使用场景

• 技术团队快速部署API文档或开发手册
• 产品团队搭建产品使用指南站点
• 企业内部知识库或帮助中心的静态站点部署

使用方法

基本部署

通过以下命令启动容器，直接访问Nginx服务提供的静态文档：

bash
docker run -d -p 80:80 --name docusaurus-site [镜像名称]

访问 http://localhost 即可查看部署的文档站点。

开发模式

如需修改文档内容并实时预览，可进入容器内部启动Docusaurus开发服务器：

bash
# 进入容器
docker exec -it docusaurus-site /bin/bash

# 启动开发服务器
npm start

此时通过 http://localhost:3000 访问开发服务器，支持热重载（通过35729端口）。

自定义文档

1. 通过卷挂载方式替换文档内容：

   bash
   docker run -d -p 80:80 -v /本地文档路径:/usr/share/nginx/html/docu/docs --name docusaurus-site [镜像名称]
   

2. 重新构建文档：

   bash
   docker exec -it docusaurus-site npm run build
   

配置说明

端口映射

目录结构

• 文档项目根目录：/usr/share/nginx/html/docu
• 文档源文件目录：/usr/share/nginx/html/docu/docs
• 构建产物目录：/usr/share/nginx/html/docu/build（Nginx默认根目录）
• Nginx配置文件：/etc/nginx/conf.d/default.conf

构建说明

镜像构建过程包含以下关键步骤：

1. 基于nginx:latest基础镜像
2. 安装Node.js 14.x环境
3. 初始化Docusaurus项目（***模板）
4. 修改Nginx配置指向构建产物目录
5. 执行npm run build生成静态文档
6. 暴露80、3000、35729端口