itzg/jekyll-github-pages

Jekyll GitHub Pages 镜像

镜像概述

本容器根据https://help.github.com/articles/using-jekyll-with-pages%E9%A2%84%E5%85%88%E9%85%8D%E7%BD%AE%EF%BC%8C%E7%94%A8%E4%BA%8E%E7%94%9F%E6%88%90%E5%92%8C%E9%A2%84%E8%A7%88%E7%AC%A6%E5%90%88GitHub Pages标准的静态网站。容器通过4000端口提供生成的网站内容，网站源文件来自容器的/site卷。用户可挂载本地网站内容，或由容器自动生成简单内容及标准Jekyll目录结构。

核心功能与特性

• 预配置环境：严格遵循GitHub Pages对Jekyll的配置要求，确保本地开发与GitHub Pages部署环境一致
• 目录结构自动生成：若挂载的本地目录为空，自动创建标准Jekyll目录结构（如_posts、_layouts等）
• 实时预览：通过4000端口提供网站预览服务，支持本地内容修改后的实时更新
• 灵活挂载：支持将本地目录挂载至容器/site卷，方便开发和内容管理

使用场景

• GitHub Pages网站本地开发与预览
• Jekyll静态网站快速原型搭建
• 学习Jekyll目录结构和配置方式

使用方法

基本运行命令

通过以下命令启动容器，挂载当前工作目录下的site文件夹作为网站源目录：

bash
docker run -it -p 4000:4000 -v $(pwd)/site:/site itzg/jekyll-github-pages

参数说明：

• -it：以交互模式运行容器，支持实时日志输出
• -p 4000:4000：将容器4000端口映射到本地4000端口，用于访问网站预览
• -v $(pwd)/site:/site：将本地当前目录下的site文件夹挂载到容器的/site卷

首次使用说明

若本地site目录为空，容器会自动初始化以下标准Jekyll目录结构及基础内容：

site/
├── _posts/          # 博客文章存放目录
├── _layouts/        # 页面布局模板目录
├── _includes/       # 可复用组件目录
├── css/             # 样式文件目录
├── index.md         # 网站首页
└── _config.yml      # Jekyll配置文件

若本地site目录已包含Jekyll项目文件，容器将直接加载并生成网站内容。

访问网站

容器启动后，通过浏览器访问 http://localhost:4000 即可预览生成的网站。