humangeo/aglio

aglio-docker

本镜像用于运行https://github.com/danielgtaylor/aglio%E2%80%94%E2%80%94NodeJS%E5%91%BD%E4%BB%A4%E8%A1%8C%E5%B7%A5%E5%85%B7%EF%BC%8C%E5%8F%AF%E5%B0%86%E5%90%ABBlueprint API标记的文本转换为HTML文件。

镜像优势

最初Aglio需兼容旧版NodeJS，本镜像打包依赖避免本地保留旧版本；当前虽问题解决，但仍支持本地资产引用、批量处理目录文件等独特功能。

核心功能

1. 转换Blueprint标记到HTML文档
2. 批量处理目录下所有.md文件
3. 替换外部资产为本地引用（自动复制到输出目录）
4. 用Aglio导航包装CHANGELOG文件（需文件名CHANGELOG且含一级标题）

使用场景

直接运行

挂载当前目录到容器/docs：

bash
docker run -ti --rm -v $PWD:/docs humangeo/aglio <文件路径>

脚本简化

1. 创建脚本~/bin/aglio：

bash
mkdir -p ~/bin && touch ~/bin/aglio && chmod +x ~/bin/aglio

2. 写入内容：

bash
#!/bin/sh -eu
script_dir=`pwd`
container_dir=/docs
docker run --rm -ti -v $script_dir:$container_dir humangeo/aglio "$@"

3. 加入PATH（Bash修改~/.bashrc）：

bash
if [ -d $HOME/bin ]; then export PATH=$HOME/bin:$PATH; fi

4. 使用：aglio <文件路径>

Maven集成

通过https://github.com/rhuss/docker-maven-plugin%E9%9B%86%E6%88%90%E5%88%B0Maven%E6%9E%84%E5%BB%BA%EF%BC%8Cexample%E7%9B%AE%E5%BD%95%E5%90%AB%E6%BC%94%E7%A4%BA%E9%A1%B9%E7%9B%AE%E3%80%82

批量处理目录

用自定义脚本处理输入目录所有.md文件：

bash
docker run -ti -v /host/input:/docker_in -v /host/output:/docker_out --entrypoint=/usr/local/bin/aglio-wrapper.sh humangeo/aglio -i /docker_in -o /docker_out

参数说明：

• -l：替换外部资产为本地引用
• -c：包装CHANGELOG文件（需符合格式要求）