hashicorp/vagrant-website

Vagrant文档网站构建镜像

镜像概述

本Docker镜像专为构建Vagrant官方文档网站设计，提供完整的文档构建环境，包含预配置的工具链和依赖组件，旨在简化Vagrant文档的开发、预览和部署流程。通过该镜像，用户无需手动配置本地环境即可快速构建和预览Vagrant文档网站。

核心功能与特性

• 完整构建环境：集成文档构建所需的全部工具（如Jekyll、Ruby依赖、Node.js等），无需额外安装依赖
• 文档预览支持：内置本地预览服务，可通过浏览器实时查看文档构建效果
• 与Vagrant文档兼容：针对Vagrant文档源文件结构优化，确保构建流程与官方标准一致
• 轻量级部署：镜像体积优化，适合本地开发和CI/CD环境集成
• 灵活配置：支持通过环境变量和挂载卷自定义构建参数（如文档分支、输出路径等）

使用场景

• 文档维护者：构建生产环境的Vagrant官方文档网站
• 开发者：本地预览文档修改效果，验证格式和内容正确性
• CI/CD集成：在持续集成流程中自动构建文档，确保文档与代码同步更新

使用方法

基本构建命令

通过以下命令启动容器并构建Vagrant文档：

bash
docker run -v /path/to/vagrant-docs:/docs \
  --name vagrant-docs-builder \
  hashicorp/vagrant-docs-builder:latest \
  build

说明：/path/to/vagrant-docs需替换为本地Vagrant文档源文件目录（通常包含_config.yml、index.md等文件）

本地预览文档

如需本地预览文档（支持实时更新），可运行：

bash
docker run -v /path/to/vagrant-docs:/docs \
  -p 4000:4000 \
  --name vagrant-docs-preview \
  hashicorp/vagrant-docs-builder:latest \
  serve

启动后，通过http://localhost:4000访问本地预览服务，修改本地文档文件后将自动重建并刷新预览内容。

环境变量配置

示例：指定分支构建文档

bash
docker run -v /path/to/vagrant-docs:/docs \
  -e DOCS_BRANCH=v2.3 \
  hashicorp/vagrant-docs-builder:latest \
  build

注意事项

• 本地文档目录需包含Vagrant文档源文件（可从https://github.com/hashicorp/vagrant/tree/main/website%E5%85%8B%E9%9A%86%EF%BC%89
• 预览模式下，容器需保持运行状态以提供实时更新；构建完成后可停止容器
• 生产环境构建建议配合CI/CD流程，将_site目录输出挂载至Web服务器或静态资源托管服务（如S3、Netlify等）