From 023d43d0fe4e2a1b4f0fbb21501fecc422a503db Mon Sep 17 00:00:00 2001 From: Nolan Brubaker Date: Fri, 14 Jun 2019 15:11:15 -0400 Subject: [PATCH] Add make serve-docs target for local viewing Signed-off-by: Nolan Brubaker --- Makefile | 8 ++++++++ site/README-JEKYLL.md | 4 ++++ 2 files changed, 12 insertions(+) diff --git a/Makefile b/Makefile index 288cca4fc..31efb63f8 100644 --- a/Makefile +++ b/Makefile @@ -214,3 +214,11 @@ changelog: release: hack/goreleaser.sh + +serve-docs: + docker run \ + --rm \ + -v "$$(pwd)/site:/srv/jekyll" \ + -it -p 4000:4000 \ + jekyll/jekyll \ + jekyll serve --livereload diff --git a/site/README-JEKYLL.md b/site/README-JEKYLL.md index 9d5d2205c..5ed0b28a6 100644 --- a/site/README-JEKYLL.md +++ b/site/README-JEKYLL.md @@ -1,3 +1,7 @@ +# Running in Docker + +To run this site in a Docker container, you can use `make serve-docs` from the root directory. + # Dependencies for MacOS Install the following for an easy to use dev environment: