amutake/satysfi

docker-satysfi 镜像文档

镜像概述

docker-satysfi 是一个包含 SATySFi 和 Satyrographos 的 Docker 镜像。SATySFi 是一款基于 OCaml 的排版编程语言，专为复杂文档（如学术论文、技术报告）排版设计；Satyrographos 是其官方包管理器，用于管理排版相关的样式和依赖。本镜像将两者预配置于容器环境中，消除本地安装和环境配置的复杂性，提供一致、隔离的排版工作环境。

核心功能与特性

• 工具集成：预安装最新稳定版 SATySFi 和 Satyrographos，开箱即可使用核心排版与包管理功能。
• 环境隔离：通过容器化避免与本地系统依赖冲突，确保排版结果跨平台一致性。
• 便捷文件操作：支持通过卷挂载（Volume Mount）访问本地文件系统，实现源文件编辑与排版结果实时输出。
• 轻量设计：基于精简基础镜像构建，平衡功能完整性与镜像体积。

使用场景与适用范围

• 学术文档排版：适用于需要复杂公式、图表和参考文献管理的学术论文、学位论文排版。
• 技术文档编写：支持技术手册、API 文档等结构化文档的自动化排版。
• 快速上手与测试：供开发者或用户在不修改本地环境的情况下，快速体验 SATySFi 的语法和功能。
• CI/CD 集成：可嵌入自动化流程，实现文档的批量生成与版本控制。

使用方法与配置说明

基本使用流程

1. 拉取镜像（若未本地缓存）：

   bash
   docker pull amutake/satysfi
   

2. 执行排版命令
   通过挂载本地工作目录（如 ./src）到容器内的 /work 目录，执行 SATySFi 编译命令：

   bash
   docker run --rm -v $(pwd)/src:/work amutake/satysfi satysfi document.saty -o output.pdf
   

   • --rm：容器退出后自动删除，避免残留。
   • -v $(pwd)/src:/work：将本地 ./src 目录挂载到容器内 /work，作为工作目录。
   • satysfi document.saty -o output.pdf：调用 SATySFi 编译 document.saty 源文件，输出 output.pdf 到挂载目录。

3. 管理依赖包
   使用 Satyrographos 安装或更新排版样式包（需在容器内执行）：

   bash
   docker run --rm -v $(pwd)/src:/work amutake/satysfi satyrographos install <package-name>
   

高级配置（可选）

• 指定工作目录：通过 -w 参数自定义容器内工作目录（默认为 /work）：

  bash
  docker run --rm -v $(pwd):/my-docs -w /my-docs amutake/satysfi satysfi main.saty
  

• 持久化依赖缓存：若需保留 Satyrographos 的包缓存，可挂载缓存目录（容器内路径通常为 ~/.satyrographos）：

  bash
  docker run --rm -v $(pwd)/src:/work -v satysfi-cache:~/.satyrographos amutake/satysfi satyrographos install collection-basic
  

  （首次运行会创建 satysfi-cache 卷，后续复用缓存）

注意事项

• 确保本地源文件路径（如 document.saty）存在于挂载目录内，否则容器无法访问。
• 输出文件（如 output.pdf）将生成在本地挂载目录中，可直接在本地查看。
• 如需使用自定义字体或非标准依赖，需通过卷挂载或构建自定义镜像集成。

参考与链接

• 官方文档：https://github.com/gfngfn/SATySFi/blob/master/doc/manual-ja.md%E3%80%81https://github.com/gfngfn/Satyrographos
• 镜像源码与更新日志：https://github.com/amutake/docker-satysfi