Update README.md

This commit is contained in:
John Mulhausen 2016-10-02 13:54:35 -07:00 committed by GitHub
parent a0ee6c6004
commit 798359abf8
1 changed files with 7 additions and 4 deletions

View File

@ -29,10 +29,13 @@ open source and we deeply appreciate contributions from our community!
You have three options:
1. (Most performant, slowest setup) Clone this repo, [install the GitHub Pages Ruby gem](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/), then run `jekyll serve` from within the directory.
2. (Slower, fast setup) Clone this repo, and from within the directory, run:
`docker run -ti --rm -v "$PWD":/docs -p 4000:4000 docs/docstage`
3. (Edit entirely in the browser, no local clone) Fork this repo in GitHub, change your fork's repository name to `YOUR_GITHUB_USERNAME.github.io`, and make any changes.
1. (Most performant, slowest setup) Clone this repo, [install the GitHub Pages Ruby gem](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/), then run `jekyll serve` from within the directory.
2. (Slower, fast setup) Clone this repo, and from within the directory, run:
```bash
docker run -ti -v "$PWD":/usr/src/app -p "4000:4000" starefossen/github-pages
```
3. (Edit entirely in the browser, no local clone) Fork this repo in GitHub, change your fork's repository name to `YOUR_GITHUB_USERNAME.github.io`, and make any changes.
In the first two options, the site will be staged at `http://localhost:4000` (unless Jekyll is behaving in some non-default way).