From 11cd0ebaa23549da83fb74810f53ee5c4a7acc88 Mon Sep 17 00:00:00 2001 From: Patrick Kremer Date: Fri, 8 Oct 2021 12:47:26 -0500 Subject: [PATCH] docs: Update website README to include Windows instructions for Jekyll container Signed-off-by: Patrick Kremer --- docs/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/README.md b/docs/README.md index 47548c51..346ea89f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -61,6 +61,7 @@ Step 1 - Change into the `docs` directory Step 2 - Run the following command to start the [Jekyll Docker container image](https://github.com/envygeeks/jekyll-docker/) and begin serving the documentation: +Linux/Mac: ```bash docker run --rm \ --volume="$PWD:/srv/jekyll" \ @@ -69,6 +70,15 @@ docker run --rm \ jekyll serve ``` +Windows: +```powershell +docker run --rm ` + --volume="${PWD}:/srv/jekyll" ` + --publish 4000:4000 ` + jekyll/jekyll ` + jekyll serve +``` + Step 3 - Once the server is ready, you can open a browser to `http://localhost:4000` to review the documentation locally. If you need to change the default port (`4000`), modify the `--publish` arguments from step 2. ```bash