markcrossfield/pages-gem repository overview

I published this Docker image from my fork⁠ of https://github.com/github/pages-gem⁠, so you can use this to get a GitHub Pages site up and running simply by using this in your compose.yaml (assuming that your jekyll site is in a docs/ directory:

services:
  github-pages:
    volumes:
      - '${PWD}/docs/:/src/site/'
    ports:
      - '4000:4000'
    image: markcrossfield/pages-gem:latest-alpine

You should then be able to run docker compose up to build and serve your GitHub Pages site.

This is not the supported way⁠ to build your site locally. However, it is built from GitHub’s own definition of a Docker container ^1⁠, and means you don’t need a working install of Ruby, Bundler, and Jekyll.

⁠Windows issues

Under Windows WSL2 there is an issue with filesystem watching⁠. This means you will get a warning and won’t be able to see changes you make to your site without killing and restarting your container. Until this is resolved, you will need to add this line to the end of your compose.yml file to get Jekyll to poll the filesystem:

    command: ["jekyll", "serve", "-H", "0.0.0.0", "-P", "4000", "--force_polling"]

⁠Footnotes

1. I checked with GitHub, but they consider their repo to be unsupported, and so have no plans to publish their own image. ↩⁠