Skip to content
This repository was archived by the owner on Nov 2, 2023. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@
_site/
node_modules/
.vscode/
.jekyll-metadata
vendor/
33 changes: 11 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
11 changes: 11 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -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