18F / uswds-jekyll

A Jekyll theme showcasing the U.S. Web Design System

Home Page:https://federalist-proxy.app.cloud.gov/site/18f/uswds-jekyll/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Docker Compose file

nathanweeks opened this issue · comments

This suggestion might be beyond the scope of this repo, but it could be useful to add a Docker Compose file to allow non-Ruby & Jekyll experts (like myself) to quickly deploy a suitable software environment and start local jekyll development server.

E.g., given the following docker-compose.yaml in the root of the git repo working tree:

version: '3'

services:
  jekyll:
    image: jekyll/jekyll:4.0
    volumes:
      - ./:/srv/jekyll
      - jekyll-cache:/usr/local/bundle
    command: jekyll serve --incremental
    ports:
      - "4000:4000"

volumes:
  jekyll-cache:

docker-compose up will start a local jekyll server (pulling a container image that was built from the jekyll/jekyll git repo) that is exposed on port 4000. Missing gems are installed and cached in a docker volume to speed subsequent startups.

Hi Nathan,

18F also maintains a Jekyll-USWDS repository for use on the Federalist web hosting platform that has a docker file and docker compose file: (https://github.com/18F/federalist-uswds-jekyl. That may help. It already uses USWDS 2.0.

Thanks Adam; looks like they were just added recently. I'll try their docker-compose.yml the next time I use Jekyll.

This project is in maintenance mode, so closing.