jvconseil/jekyll-docker

Jekyll Docker

概述

Jekyll Docker是一个预配置Jekyll及其依赖的软件镜像，以封装格式提供即用型环境。它包含默认的 gems 集、包装器和额外软件包，主要供通过CI将Jekyll构建结果部署到其他服务器的用户使用。

镜像类型

Builder（支持）

builder镜像（jvconseil/jekyll-docker）包含标准镜像中未提供的额外工具，如lftp、openssh等，专为需要通过CI将Jekyll构建部署到其他服务器的用户设计。

使用方法

sh
export JEKYLL_VERSION=4.3.3
docker run --rm \
  --volume="$PWD:/srv/jekyll:Z" \
  -it jvconseil/jekyll-docker:$JEKYLL_VERSION \
  jekyll build

Standard（不支持）

标准镜像（jvconseil/jekyll）已不再支持，原包含默认"dev"包、Node.js及社区维护的常用gems，简化Jekyll使用。

使用方法（仅作历史参考）

sh
export JEKYLL_VERSION=4.3.3
docker run --rm \
  --volume="$PWD:/srv/jekyll:Z" \
  -it jvconseil/jekyll:$JEKYLL_VERSION \
  jekyll build

Windows (cmd)快速启动（仅作历史参考）

cmd
set site_name=my-blog
docker run --rm --volume="%CD%:/srv/jekyll" -it jvconseil/jekyll sh -c "chown -R jekyll /usr/gem/ && jekyll new %site_name%" && cd %site_name%

Linux / Git Bash快速启动（仅作历史参考）

Linux用户可跳过export MSYS_NO_PATHCONV=1（用于兼容性处理）：

sh
export site_name="my-blog" && export MSYS_NO_PATHCONV=1
docker run --rm \
  --volume="$PWD:/srv/jekyll" \
  -it jvconseil/jekyll \
  sh -c "chown -R jekyll /usr/gem/ && jekyll new $site_name" \
  && cd $site_name

Minimal（不支持）

minimal镜像（jvconseil/jekyll-minimal）已不再支持，体积极小，不含额外gems和开发依赖，仅保留基础Jekyll。

使用限制（仅作历史参考）

需提供.apk文件以支持Nokogiri等工具，因未安装开发头文件或依赖，C语言编写的gems可能安装失败。

sh
export JEKYLL_VERSION=4.3.3
docker run --rm \
  --volume="$PWD:/srv/jekyll:Z" \
  -it jvconseil/jekyll-minimal:$JEKYLL_VERSION \
  jekyll build

核心功能与特性

• 预配置环境：包含Jekyll及常用依赖，无需手动安装
• CI部署支持：builder镜像集成lftp、openssh等部署工具
• 本地开发服务：支持jekyll serve启动本地服务器，实时预览网站
• 灵活配置：通过环境变量调整UID/GID、调试模式等参数
• 依赖管理：支持Gemfile自动安装依赖，提供缓存机制加速构建
• rootless容器兼容：设置JEKYLL_ROOTLESS环境变量支持无root容器

使用场景

• Jekyll网站的快速开发与构建
• 通过CI/CD流程自动化部署Jekyll站点到远程服务器
• 隔离Jekyll开发环境，避免系统依赖冲突
• 需要精简构建流程的场景（使用builder镜像）

本地开发服务器

本地开发时，可在容器内运行Jekyll服务器，监听文件变化并自动重建，通过http://localhost:4000访问预览：

sh
docker run --rm \
  --volume="$PWD:/srv/jekyll:Z" \
  --publish [::1]:4000:4000 \
  jvconseil/jekyll-docker \
  jekyll serve

依赖管理

Gem依赖

镜像会自动安装Gemfile中指定的依赖（匹配Gemfile.lock版本），包括Jekyll本身。如需更新依赖：

sh
export JEKYLL_VERSION=4.3.3
docker run --rm \
  --volume="$PWD:/srv/jekyll:Z" \
  -it jvconseil/jekyll-docker:$JEKYLL_VERSION \
  bundle update

依赖缓存

通过挂载缓存卷加速构建（适用于CI环境）：

sh
export JEKYLL_VERSION=4.3.3
docker run --rm \
  --volume="$PWD:/srv/jekyll:Z" \
  --volume="$PWD/vendor/bundle:/usr/local/bundle:Z" \
  -it jvconseil/jekyll-docker:$JEKYLL_VERSION \
  jekyll build

注意：缓存卷根目录（如vendor）需在_config.yml的exclude数组中排除，避免Jekyll构建时处理。

Rootless容器

使用无root容器管理系统时，设置JEKYLL_ROOTLESS环境变量（非空值）：

sh
podman run -ti --rm -v .:/srv/jekyll -e JEKYLL_ROOTLESS=1 docker.io/jvconseil/jekyll-docker jekyll new .

配置参数

通过环境变量配置Jekyll行为：

系统包安装

通过.apk文件安装系统包（每行一个包名），包名可查询Alpine Linux软件包站。builder镜像默认包含ruby-dev、xml、xslt、git等常用依赖，满足多数Ruby包需求。

credits

本Docker镜像受https://github.com/envygeeks/jekyll-docker%E5%90%AF%E5%8F%91%EF%BC%8C%E5%9C%A8%E5%85%B6%E5%9F%BA%E7%A1%80%E4%B8%8A%E6%94%B9%E8%BF%9B%E5%8A%9F%E8%83%BD%E5%92%8C%E7%89%88%E6%9C%AC%E3%80%82

赞助

如果本项目对您有帮助，欢迎请我喝杯咖啡☕️:-)