lsiodev/doc-builder

linuxserver/doc-builder 镜像文档

概述

linuxserver/doc-builder 是 LinuxServer.io (LSIO) CI 流程的专用组件，主要用于文档构建。该镜像不供公众常规使用，仅作为 LSIO 内部 CI 流程的一部分。

核心功能与特性

• 专为 LSIO CI 流程设计，支持自动化文档构建
• 提供两种运行模式：远程 CI 环境运行和本地测试运行
• 本地测试模式下可生成 GENERATED.md 文档输出

使用场景

• LSIO 内部持续集成 (CI) 流程中的文档自动构建环节
• LSIO 开发人员本地测试文档构建功能

使用方法

1. 远程 CI 环境运行

在 LSIO CI 流程中使用时，执行以下命令：

bash
docker run --rm \
 -e CONTAINER_NAME=${CONTAINER_NAME} \
 -v ${TEMPDIR}:/ansible/readme \
 linuxserver/doc-builder:latest

参数说明：

• -e CONTAINER_NAME=${CONTAINER_NAME}: 设置容器名称环境变量（CI 环境变量）
• -v ${TEMPDIR}:/ansible/readme: 挂载临时目录到容器内的 /ansible/readme 路径

2. 本地测试运行

如需本地测试文档构建功能，在包含 readme-vars.yml 文件的目录中执行：

bash
docker run --rm \
 -v $(pwd):/tmp \
 -e LOCAL=true \
 linuxserver/doc-builder:latest

参数说明：

• -v $(pwd):/tmp: 将当前工作目录挂载到容器内的 /tmp 路径
• -e LOCAL=true: 设置本地运行模式

输出说明：本地运行时，生成的文档将保存为当前工作目录下的 GENERATED.md 文件。

环境变量