cakephpfr/docs

cakephpfr/docs镜像说明

镜像概述

本镜像提供了用于贡献CakePHP文档的开发环境，基于Sphinx文档生成工具，包含两种版本（带LaTeX的完整版和仅Sphinx的轻量版），帮助开发者快速搭建文档编辑与预览环境。

核心功能

• 支持使用Sphinx生成CakePHP文档
• 提供含LaTeX的版本，可生成PDF等多格式文档
• 轻量版仅包含Sphinx基础功能，适合快速编辑
• 便于本地测试文档构建效果，加速贡献流程

使用场景

• 开发者参与CakePHP官方文档的编写、修改与预览
• 生成HTML、PDF等格式的文档用于本地验证
• 团队协作中统一文档开发环境

配置说明

参考GitHub仓库对应版本的README获取详细配置：

• full版本（带LaTeX的Sphinx）：https://github.com/cakephp-fr/docker/tree/master/cakephp/docs/full
• light版本（仅Sphinx）：https://github.com/cakephp-fr/docker/tree/master/cakephp/docs/light

部署示例

Docker Run命令

bash
# 使用full版本
docker run -v /本地文档目录:/app docker.xuanyuan.run/cakephpfr/docs:full

# 使用light版本
docker run -v /本地文档目录:/app docker.xuanyuan.run/cakephpfr/docs:light

Docker Compose示例

yaml
version: '3'
services:
  docs:
    image: cakephpfr/docs:full
    volumes:
      - ./docs:/app
    command: make html