scisoftware/docusaurus

Docusaurus Docker镜像

镜像概述

本Docker镜像用于运行Docusaurus文档服务器，可通过http://localhost:3000访问。Docusaurus是一款优秀的开源项目网站构建工具，相比其他同类产品具有显著优势。该镜像项目托管于https://github.com/SciSoftwareSlawomirCichy/docker-docusaurus%E3%80%82

!https://github.com/SciSoftwareSlawomirCichy/docker-docusaurus/blob/main/docs/img/localhost_main_page.png?raw=true

核心功能与特性

• 快速部署Docusaurus文档服务器，无需复杂环境配置
• 支持持久化存储项目文件和Git版本控制数据
• 跨平台兼容，支持Linux和Windows系统
• 提供Docker Compose配置示例，简化部署流程

镜像卷声明

镜像中声明了两个卷，用于数据持久化：

有关Docusaurus项目结构的更多信息，请参考官方文档。

使用方法

Linux系统

前置准备

设置环境变量NMP_VERSION和VOLUME_HOME：

bash
export NMP_VERSION=11.6.0
export VOLUME_HOME=/d/workspace/git/<my-webpage>

运行容器

bash
docker run --name docusaurus --rm -it \
 -v $VOLUME_HOME:/webdir/public \
 -p 3000:3000 \
 scisoftware/docusaurus:${NMP_VERSION}

Linux系统 - Docker Compose

创建配置文件

创建sample-compose.yml文件，内容如下：

[!WARNING] 请确保正确定义卷路径

yaml
networks:
  default-network:
    driver: bridge

volumes:
  webpage:
    driver: local
    driver_opts:
      o: bind
      type: none
      device: /d/workspace/git/docker-docusaurus/test-folder
 
services:
  my-webpage-sample:
    image: scisoftware/docusaurus:latest
    networks:
      - default-network
    environment:
      - WORKSPACE_NAME=public	  
    volumes: 
      - webpage:/webdir/public
    ports:
      - "3000:3000"

启动服务

bash
docker compose -f sample-compose.yml up

Windows系统 (PowerShell)

前置准备

设置环境变量NMP_VERSION和VOLUME_HOME：

bash
set NMP_VERSION=11.6.0
set VOLUME_HOME=/d/workspace/git/<my-webpage>

运行容器

shell
docker run --name docusaurus --rm -it `
 -v %VOLUME_HOME%:/webdir/public `
 -p 3000:3000 `
 scisoftware/docusaurus:%NMP_VERSION%

GitHub与Docusaurus的主要差异

Markdown语法差异

提示框(Tips)

在GitHub中使用：

md
> [!TIP]
> Use this awesome feature option

在Docusaurus中使用：

md
:::tip My tip

Use this awesome feature option

:::

关于Docusaurus

Docusaurus是一个用于轻松构建、部署和维护开源项目网站的工具。

来源：https://github.com/***/docusaurus

参考资料

• Docusaurus官方文档
• 创建自定义Docusaurus镜像