diff --git a/.gitignore b/.gitignore index 6fe13fcd..778ea372 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,5 @@ _site/ node_modules/ .vscode/ +.jekyll-metadata +vendor/ diff --git a/README.md b/README.md index 72766976..2a457cd9 100644 --- a/README.md +++ b/README.md @@ -19,28 +19,17 @@ Labels are assigned based on [Sensible Github Labels](https://github.com/Releque ## Compile and run locally This site runs via github pages, with automatically building PR previews via netlify. -If you wish to compile and run this site locally, you will need to have ruby installed. - -If you're not familiar with ruby, consider using `rvm` (https://rvm.io/). -Once you have Ruby installed, follow these instructions while in the project directory - -> Instructions -> -> 1. Install the jekyll and bundler gems. -> -> `gem install jekyll bundler` -> -> 2. Create a new Jekyll site at ./myblog. -> -> ... -> -> 3. Build the site and make it available on a local server. -> -> `bundle exec jekyll serve` -> -> 4. Browse to http://localhost:4000 - -Adapted from https://jekyllrb.com/docs/ + +This project uses git submodules, so you will need to run the following commands +to fully clone the repo. + +```bash +git submodule init +git submodule update +``` + +You can run the site locally using `docker-compose up` and browse to +http://localhost:4000 ## License diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 00000000..9b51565a --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,11 @@ +version: "3.9" + +services: + web: + image: docker.io/jekyll/jekyll + volumes: + - .:/srv/jekyll:Z + - ./vendor/bundle:/usr/local/bundle:Z + ports: + - "4000:4000" + command: jekyll serve --incremental --watch