Skip to content

Commit 18ce3f5

Browse files
committed
📝 Add info about Jekyll (+Docker)
1 parent 096aa0c commit 18ce3f5

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,20 @@ The website is built using [Jekyll](http://jekyllrb.com/). Github hosts static
99

1010
Getting involved is easy. You don't even NEED Jekyll installed locally, but it helps. Changes and pull requests are encouraged. Want to fix a typo. Add some info? Add a page, or more? Go for it.
1111

12+
## Setup Jekyll
13+
14+
Two easy options to get going with Jekyll.
15+
16+
* Instructions to install [Jekyll](https://jekyllrb.com/docs/quickstart/)
17+
* If you have [Docker](https://www.docker.com/community-edition), here's a couple options.
18+
* If you already have Docker installed, this simple one line command will build and host jekyll [(bretfisher/jekyll-serve)](https://github.com/bretfisher/jekyll-serve).:
19+
`docker run -p 4000:4000 -v "$PWD:/site" bretfisher/jekyll-serve`
20+
* Or a more robust solution [Docker + Jekyll](https://github.com/envygeeks/jekyll-docker).
21+
1222
### Here's How
1323

1424
1. `Fork` the repository: [How to Fork](https://help.github.com/articles/fork-a-repo/).
15-
1. Make changes.
25+
1. Make changes.
1626
1. Optionally, enable Travis for yourself on this repo: `https://travis-ci.org/profile/**username**`. [Read more](http://jekyllrb.com/docs/continuous-integration/)
1727
1. Create a `Pull Request` to share: [How to create a Pull Request](https://help.github.com/articles/using-pull-requests/)
1828

0 commit comments

Comments
 (0)