hashicorp/nomad-website

Nomad文档网站构建镜像

概述

该镜像专为构建Nomad文档网站设计，提供预配置的构建环境，集成文档构建所需工具链，简化Nomad文档的本地开发、预览及生产环境构建流程。

特性

• 集成必要构建工具（如Hugo、Node.js等），无需手动配置依赖
• 预配置Nomad文档专用构建环境，支持模板渲染与静态资源处理
• 轻量级设计，基于高效基础镜像，缩短构建耗时
• 支持本地目录挂载，实现文档内容实时预览与构建

使用场景

• 开发人员本地构建和预览Nomad文档，验证内容格式与页面布局
• CI/CD流水线中自动化执行文档构建，生成生产就绪的静态网站文件
• 多版本文档管理，通过环境变量指定版本，构建特定版本的文档网站

部署方案示例

本地构建文档

挂载本地文档目录，执行构建命令生成静态网站文件：

bash
docker run --rm -v $(pwd)/docs:/app/docs nomad-docs-builder \
  hugo --source /app/docs --destination /app/docs/public

参数说明：

• --rm：构建完成后自动清理容器
• -v $(pwd)/docs:/app/docs：挂载本地文档源目录（需包含config.toml、content等文件）至容器内/app/docs
• hugo --source /app/docs --destination /app/docs/public：使用Hugo构建文档，输出至本地docs/public目录

本地预览文档

启动内置服务器实时预览文档变更：

bash
docker run -d -p 1313:1313 -v $(pwd)/docs:/app/docs nomad-docs-builder \
  hugo server --source /app/docs --bind 0.0.0.0 --port 1313

访问http://localhost:1313即可预览，本地修改文档内容将实时更新。

注意事项

• 确保本地文档目录结构符合要求（需包含content、layouts、config.toml等核心文件）
• 挂载目录需配置读写权限，避免构建过程中出现权限错误
• 生产环境构建可通过HUGO_ENV=production环境变量启用资源压缩与优化