starefossen/github-pages

Alpine Docker GitHub Pages ![Image Layers]([***]

基于Alpine Linux的轻量Docker镜像，专为运行GitHub Pages/Jekyll项目设计，体积仅70MB，支持本地开发时自动刷新内容变更。

!https://raw.githubusercontent.com/Starefossen/docker-github-pages/master/assets/demo.gif

支持的标签及Dockerfile链接

• https://github.com/Starefossen/docker-github-pages/blob/master/Dockerfile
• https://github.com/Starefossen/docker-github-pages/blob/master/onbuild/Dockerfile

什么是GitHub Pages

GitHub Pages是通过GitHub仓库直接托管和发布的公共静态网页服务，无需额外服务器即可展示项目文档或个人博客。

核心功能

1. 本地开发实时预览：自动检测文件变更并刷新页面
2. 轻量高效：基于Alpine Linux，镜像体积仅70MB
3. 完整支持GitHub Pages特性：包括jekyll-github-metadata、jemoji等扩展
4. 灵活配置：支持环境变量注入和卷挂载

使用场景

• 本地开发GitHub Pages项目，快速预览效果
• 团队协作中统一开发环境，避免依赖冲突
• 快速搭建静态网页原型

配置说明

基础运行命令

bash
docker run -it --rm -v "$PWD":/usr/src/app -p "4000:4000" starefossen/github-pages

访问http://localhost:4000即可查看页面。

配置文件要求

在项目根目录的_config.yml中添加必要依赖：

yaml
repository: your/repo
gems:
- jekyll-github-metadata
- jekyll-mentions
- jekyll-redirect-from
- jekyll-sitemap
- jemoji

注入GitHub令牌

为获取{{ site.github }}元数据，需设置环境变量：

bash
docker run \
  -t --rm \
  -v "$PWD":/usr/src/app \
  -e JEKYLL_GITHUB_TOKEN=your-github-token \
  -p "4000:4000" starefossen/github-pages

Docker Compose配置

创建docker-compose.yml：

yaml
version: '3'
services:
  jekyll:
    image: starefossen/github-pages
    environment:
      - "JEKYLL_GITHUB_TOKEN:${JEKYLL_GITHUB_TOKEN}"
    ports:
      - "4000:4000"
    volumes:
      - ./:/usr/src/app
    tty: true

执行docker-compose up启动服务。

镜像变体

• latest：默认版本，适用于直接运行或作为基础镜像
• onbuild：简化衍生镜像构建，只需在项目中添加FROM starefossen/github-pages:onbuild即可生成独立镜像

许可证

本镜像遵循https://github.com/Starefossen/docker-github-pages/blob/master/LICENSE%EF%BC%8C%E5%8C%85%E5%90%AB%E7%9A%84%E8%BD%AF%E4%BB%B6%E7%BB%84%E4%BB%B6%E5%9D%87%E4%BD%BF%E7%94%A8%E5%90%88%E8%A7%84%E5%BC%80%E6%BA%90%E8%AE%B8%E5%8F%AF%E8%AF%81%EF%BC%88%E5%A6%82MIT%E3%80%81BSD%EF%BC%89%E3%80%82

用户反馈

• 文档：Docker、Jekyll、https://pages.github.com
• 问题反馈：https://github.com/Starefossen/docker-github-pages/issues
• 贡献：欢迎通过Pull Request提交改进，建议先通过Issue讨论方案