Skip to content

Commit

Permalink
docs: Update website README to include Windows instructions for Jekyl…
Browse files Browse the repository at this point in the history
…l container

Signed-off-by: Patrick Kremer <pkremer@vmware.com>
  • Loading branch information
Patrick Kremer committed Oct 8, 2021
1 parent 7bc5569 commit 11cd0eb
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" \
Expand All @@ -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
Expand Down

0 comments on commit 11cd0eb

Please sign in to comment.