tutum/slate

tutum-docker-slate 镜像文档

镜像概述

tutum-docker-slate 是基于 https://github.com/tripit/slate 的 Docker 化版本。Slate 是由 Tripit 开发的 API 文档生成工具，旨在帮助开发者创建美观、响应式且易于维护的 API 文档。该镜像将 Slate 的功能封装为 Docker 容器，简化了文档生成和预览的流程。

核心功能与特性

• 美观的文档输出：生成具有现代设计风格的 API 文档，支持多列布局和语法高亮
• 响应式设计：文档在桌面端、平板和移动设备上均有良好的显示效果
• Markdown 支持：使用 Markdown 格式编写文档内容，降低编写门槛
• 本地预览：通过容器运行可快速预览文档效果，无需复杂的本地环境配置
• 易于部署：Docker 容器化设计，便于在不同环境中快速部署和使用

使用场景与适用范围

• 开发团队编写和展示项目 API 文档
• 需要快速生成美观文档的个人开发者
• 项目文档的本地预览和迭代优化
• 作为 CI/CD 流程的一部分，自动化生成和部署 API 文档

使用方法与配置说明

前提条件

• 已安装 Docker 环境
• 文档源文件夹结构需符合 Slate 要求（可参考 https://github.com/tripit/slate/tree/master/source%EF%BC%89

步骤 1：创建 Dockerfile

在文档源文件夹中，创建 Dockerfile 并添加以下内容：

dockerfile
FROM tutum/slate

步骤 2：构建镜像

在文档源文件夹所在目录，执行以下命令构建镜像：

bash
docker build -t mydocs .

步骤 3：运行容器

使用以下命令运行容器，将容器的 4567 端口映射到本地的 4567 端口：

bash
docker run -d -p 4567:4567 mydocs

步骤 4：访问文档

打开浏览器，访问 http://localhost:4567/ 即可查看生成的 API 文档。

部署示例

Docker Compose 配置（可选）

如果需要使用 Docker Compose 管理容器，可以创建 docker-compose.yml 文件：

yaml
version: '3'
services:
  slate-docs:
    build: .
    ports:
      - "4567:4567"
    restart: always

执行 docker-compose up -d 启动服务，文档将在后台持续运行并可通过 http://localhost:4567/ 访问。