hashicorp/terraform-website

Terraform文档网站构建镜像

镜像概述

本Docker镜像专为构建Terraform文档网站设计，提供标准化的文档构建环境及完整工具链，旨在简化Terraform官方文档及衍生文档的本地开发、编译渲染与预览流程，确保文档构建环境的一致性与可重复性。

核心功能与特性

• 完整构建环境：内置文档构建所需的全部依赖（包括编译工具、渲染引擎、样式处理工具等）
• 官方流程兼容：严格遵循Terraform官方文档构建规范，确保输出结果与官方一致
• 多阶段支持：支持文档源码编译、静态资源生成、本地预览等完整流程
• 简化工作流：通过容器化方式消除本地环境配置差异，降低文档开发门槛

使用场景与适用范围

• 文档贡献者：Terraform文档贡献者进行本地文档编写、预览和测试
• 团队协作：需要统一文档构建标准的开发团队，确保多人协作时环境一致性
• CI/CD集成：集成到自动化流水线，实现文档变更后的自动构建与部署
• 快速验证：临时验证文档格式、样式或内容变更效果

使用方法与配置说明

基本使用（本地构建）

bash
# 挂载本地文档目录并执行构建
docker run -it --rm \
  -v /本地文档目录:/docs \
  -w /docs \
  [镜像名称] \
  make build  # 执行构建命令（具体命令需参考镜像内置构建脚本）

本地预览模式

bash
# 启动本地预览服务器（默认端口可能为3000，具体需参考镜像说明）
docker run -it --rm \
  -v /本地文档目录:/docs \
  -p 3000:3000 \
  -w /docs \
  [镜像名称] \
  make serve  # 启动预览服务

环境变量配置

Docker Compose配置示例

yaml
version: '3'
services:
  docs-builder:
    image: [镜像名称]
    volumes:
      - ./local-docs:/docs
    ports:
      - "3000:3000"
    environment:
      - PREVIEW_MODE=true
      - OUTPUT_DIR=/docs/output
    command: make serve

注意事项

1. 本地文档目录需包含符合Terraform文档规范的源码结构
2. 构建命令（如make build）需根据镜像实际内置的构建脚本调整
3. 预览服务端口可能因镜像配置不同而变化，需参考具体镜像文档
4. 对于大型文档项目，建议分配足够的容器资源（CPU/内存）以确保构建效率