vvakame/review

Re:VIEW Docker镜像

镜像概述和主要用途

本镜像用于在Docker环境中运行https://github.com/kmuto/review/%E2%80%94%E2%80%94%E4%B8%80%E6%AC%BE%E7%94%A8%E4%BA%8E%E4%B9%A6%E7%B1%8D%E5%92%8C%E6%96%87%E6%A1%A3%E5%88%B6%E4%BD%9C%E7%9A%84%E6%8E%92%E7%89%88%E5%B7%A5%E5%85%B7%E3%80%82%E9%80%9A%E8%BF%87%E5%AE%B9%E5%99%A8%E5%8C%96%E9%83%A8%E7%BD%B2%EF%BC%8C%E5%8F%AF%E6%8F%90%E4%BE%9B%E4%B8%80%E8%87%B4%E7%9A%84Re:VIEW%E8%BF%90%E8%A1%8C%E7%8E%AF%E5%A2%83%EF%BC%8C%E9%81%BF%E5%85%8D%E6%9C%AC%E5%9C%B0%E7%8E%AF%E5%A2%83%E9%85%8D%E7%BD%AE%E5%B7%AE%E5%BC%82%E5%B8%A6%E6%9D%A5%E7%9A%84%E9%97%AE%E9%A2%98%E3%80%82%E9%95%9C%E5%83%8F%E5%B7%B2%E5%8F%91%E5%B8%83%E8%87%B3https://hub.docker.com/r/vvakame/review/%EF%BC%88Trusted Build）和https://github.com/users/vvakame/packages/container/package/review%EF%BC%8C%E6%96%B9%E4%BE%BF%E7%9B%B4%E6%8E%A5%E4%BD%BF%E7%94%A8%E3%80%82Windows%E7%94%A8%E6%88%B7%E5%8F%AF%E5%8F%82%E8%80%83https://github.com/vvakame/docker-review/blob/master/doc/windows-review.md%EF%BC%8C%E4%B9%9F%E6%94%AF%E6%8C%81%E9%80%9A%E8%BF%87docker-compose%E4%BD%BF%E7%94%A8%E3%80%82

核心功能和特性

支持的标签版本

针对Re:VIEW不同版本提供镜像，当前支持的标签包括：latest、3.2、4.2、5.0、5.1、5.2、5.3、5.4。历史版本2.3、2.4、2.5虽在Docker Hub上存在，但已停止支持。

预装组件

• 基础工具：git、curl
• 排版环境：TeXLive及日本语支持
• 索引工具：MeCab（Re:VIEW索引生成用）
• 运行环境：Ruby（含Re:VIEW、rake、bundler）
• 扩展工具：Node.js & npm（支持https://github.com/TechBooster/ReVIEW-Template%EF%BC%89%E3%80%81pandoc%E3%80%81pandoc2review

详细组件可参考https://github.com/vvakame/docker-review/blob/master/Dockerfile%E3%80%82

TeX字体配置

PDF生成默认使用https://github.com/trueroad/HaranoAjiFonts%E5%B9%B6%E8%87%AA%E5%8A%A8%E5%B5%8C%E5%85%A5%E5%AD%97%E4%BD%93%EF%BC%8C%E6%94%AF%E6%8C%81%E5%88%87%E6%8D%A2%E5%85%B6%E4%BB%96%E5%AD%97%E4%BD%93%EF%BC%9A

• IPA字体：执行 kanji-config-updmap ipaex
• Noto字体：先执行 apt-get install fonts-not-cjk-extra，再执行 kanji-config-updmap noto-otc

使用场景和适用范围

适用于使用Re:VIEW进行书籍、技术文档创作的开发者、作者或出版团队，尤其适合需要跨平台一致构建环境、简化依赖管理的场景，可用于本地开发、CI/CD流程中的文档构建等。

使用方法和配置说明

拉取镜像

从Docker Hub拉取：

bash
docker pull vvakame/review:5.4  # 示例版本，可替换为其他支持标签
docker pull vvakame/review:5.3
# ...其他版本

从GitHub Container Registry拉取：

bash
docker pull ghcr.io/vvakame/review:5.4  # 示例版本
docker pull ghcr.io/vvakame/review:5.3
# ...其他版本

目录结构示例

假设项目结构如下（config.yml为Re:VIEW配置文件）：

├── README.md
└── src
    ├── catalog.yml
    ├── config.yml
    ├── ch01.re
    ├── ch02.re
    ├── ch03.re
    ├── index.re
    └── layouts

基本使用步骤

1. 挂载工作目录：将包含config.yml的目录（如上述src）挂载到容器内的/work目录（路径可自定义）。

2. 执行构建命令：在容器内进入挂载目录，运行Re:VIEW构建命令（如生成PDF）。

完整示例（生成PDF）

bash
docker run --rm -v `pwd`/src:/work vvakame/review /bin/sh -c "cd /work && rake pdf"

• --rm：构建完成后自动删除容器
• -v pwd/src:/work：将本地src目录挂载到容器/work目录
• vvakame/review：使用的镜像名称
• cd /work && rake pdf：进入工作目录并执行PDF生成命令

构建完成后，PDF文件将输出至本地src目录。