Skip to content
This repository was archived by the owner on Nov 2, 2023. It is now read-only.

Commit efcf9db

Browse files
committed
Develop locally with docker
1 parent 6840267 commit efcf9db

File tree

3 files changed

+24
-22
lines changed

3 files changed

+24
-22
lines changed

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,5 @@
33
_site/
44
node_modules/
55
.vscode/
6+
.jekyll-metadata
7+
vendor/

README.md

+11-22
Original file line numberDiff line numberDiff line change
@@ -19,28 +19,17 @@ Labels are assigned based on [Sensible Github Labels](https://github.com/Releque
1919
## Compile and run locally
2020

2121
This site runs via github pages, with automatically building PR previews via netlify.
22-
If you wish to compile and run this site locally, you will need to have ruby installed.
23-
24-
If you're not familiar with ruby, consider using `rvm` (https://rvm.io/).
25-
Once you have Ruby installed, follow these instructions while in the project directory
26-
27-
> Instructions
28-
>
29-
> 1. Install the jekyll and bundler gems.
30-
>
31-
> `gem install jekyll bundler`
32-
>
33-
> 2. Create a new Jekyll site at ./myblog.
34-
>
35-
> ...
36-
>
37-
> 3. Build the site and make it available on a local server.
38-
>
39-
> `bundle exec jekyll serve`
40-
>
41-
> 4. Browse to http://localhost:4000
42-
43-
Adapted from https://jekyllrb.com/docs/
22+
23+
This project uses git submodules, so you will need to run the following commands
24+
to fully clone the repo.
25+
26+
```bash
27+
git submodule init
28+
git submodule update
29+
```
30+
31+
You can run the site locally using `docker-compose up` and browse to
32+
http://localhost:4000
4433

4534
## License
4635

docker-compose.yml

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
version: "3.9"
2+
3+
services:
4+
web:
5+
image: docker.io/jekyll/jekyll
6+
volumes:
7+
- .:/srv/jekyll:Z
8+
- ./vendor/bundle:/usr/local/bundle:Z
9+
ports:
10+
- "4000:4000"
11+
command: jekyll serve --incremental --watch

0 commit comments

Comments
 (0)