rancher/docs

Docs Website 镜像文档

一、镜像概述和主要用途

Docs Website 是一个轻量级 Docker 镜像，专为快速部署文档网站设计，支持静态及动态文档的托管与展示。该镜像内置 Web 服务器与文档解析引擎，可直接加载并渲染多种格式的文档文件，适用于技术文档、项目手册、知识库等场景的快速上线，无需复杂的服务器配置。

二、核心功能和特性

2.1 核心功能

• 多格式支持：兼容 Markdown（.md）、HTML（.html）、PDF（.pdf）、纯文本（.txt）等主流文档格式。
• 内置 Web 服务：集成 Nginx 作为 Web 服务器，提供高性能文档访问体验。
• 动态渲染：自动解析文档结构，生成目录导航、搜索功能及响应式布局。
• 实时更新：挂载外部文档目录时，支持文档内容实时更新，无需重启容器。

2.2 特性

• 轻量级：镜像体积小于 100MB，启动速度快，资源占用低。
• 可定制化：支持通过环境变量或配置文件自定义端口、路径、主题及语言。
• 易集成：支持 CI/CD 流程集成，可通过 Git 自动拉取文档更新并重新部署。
• 跨平台：兼容 Linux、macOS、Windows 等主流操作系统的 Docker 环境。

三、使用场景和适用范围

3.1 典型使用场景

• 技术文档托管：API 文档、SDK 使用手册、开发指南等技术文档的在线展示。
• 项目文档站点：替代 GitHub Pages，本地化部署项目 README、CHANGELOG 等文档。
• 内部知识库：企业/团队内部的流程规范、培训材料、FAQ 等文档集中管理。
• 产品说明文档：面向用户的产品手册、功能说明、帮助中心内容展示。

3.2 适用范围

• 个人开发者：快速搭建个人项目文档站点。
• 小团队：低成本部署团队共享文档平台。
• 企业：内部文档管理、对外产品文档发布。

四、使用方法和配置说明

4.1 基本使用（docker run）

4.1.1 快速启动（默认配置）

bash
docker run -d -p 8080:80 --name docs-website -v /path/to/local/docs:/app/docs docs-website:latest

• 说明：
  • -p 8080:80：将容器内 80 端口映射到主机 8080 端口（默认 Web 服务端口为 80）。
  • -v /path/to/local/docs:/app/docs：挂载本地文档目录（需包含 Markdown/HTML 等文件）到容器内 /app/docs（默认文档路径）。
  • 访问 http://localhost:8080 即可查看文档网站。

4.1.2 自定义端口与文档路径

bash
docker run -d \
  -p 9000:9000 \
  --name docs-website \
  -v /path/to/custom/docs:/data/docs \
  -e PORT=9000 \
  -e DOCS_PATH=/data/docs \
  docs-website:latest

• 参数说明：
  • -e PORT=9000：自定义 Web 服务端口为 9000（需同步映射主机端口）。
  • -e DOCS_PATH=/data/docs：指定容器内文档存放路径为 /data/docs（需对应挂载目录）。

4.2 docker-compose 配置示例

创建 docker-compose.yml 文件：

yaml
version: '3'
services:
  docs-website:
    image: docs-website:latest
    container_name: docs-website
    restart: always
    ports:
      - "8080:80"  # 主机端口:容器端口（默认容器端口 80）
    volumes:
      - ./local-docs:/app/docs  # 本地文档目录挂载
      - ./custom-config:/app/config  # 自定义配置文件挂载（可选）
    environment:
      - DOCS_PATH=/app/docs  # 容器内文档路径（需与 volumes 挂载路径一致）
      - THEME=default  # 文档主题（支持 default、dark、light）
      - LANGUAGE=zh-CN  # 界面语言（支持 zh-CN、en-US、ja-JP 等）
      - AUTO_REFRESH=true  # 启用文档变更自动刷新（默认 false）

• 启动命令：

  bash
  docker-compose up -d
  

4.3 环境变量配置

4.4 持久化与自定义配置

4.4.1 文档文件持久化

通过 -v 挂载本地目录到 DOCS_PATH（默认 /app/docs），确保容器重启后文档内容不丢失：

bash
-v /host/path/to/docs:/app/docs  # 本地文档目录 → 容器内文档路径

4.4.2 自定义配置文件

如需修改 Web 服务器（如 Nginx）或文档解析引擎配置，可挂载自定义配置文件到容器内对应路径：

bash
-v /host/path/to/nginx.conf:/etc/nginx/conf.d/default.conf  # 自定义 Nginx 配置
-v /host/path/to/docs-config.yml:/app/config/config.yml      # 自定义文档引擎配置

五、注意事项

1. 文档格式要求：推荐使用 Markdown 格式（.md），支持标题层级（# 至 ######）、列表、链接、图片等语法，图片需放在文档目录下并使用相对路径引用。
2. 权限问题：本地挂载目录需确保 Docker 进程有读权限（可通过 chmod 755 /host/path/to/docs 调整）。
3. 性能优化：对于大量文档（>1000 个文件），建议启用 AUTO_REFRESH=false 并通过重启容器更新文档。
4. 安全建议：生产环境中建议配合反向代理（如 Traefik、Nginx）启用 HTTPS。