diff --git a/README.md b/README.md index ed5e070..4d86f95 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,9 @@ Ratchet's documentation is built with [Jekyll](http://jekyllrb.com) and publicly ### Running documentation locally 1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation). + - **Windows users:** Read [this unofficial guide](https://github.com/juthilo/run-jekyll-on-windows/) to get Jekyll up and running without problems. We use Pygments for syntax highlighting, so make sure to read the sections on installing Python and Pygments. 2. From the root `/ratchet/docs` directory, run `jekyll serve` in the command line. + - **Windows users:** While we use Jekyll's `encoding` setting, you might still need to change the command prompt's character encoding ([code page](http://en.wikipedia.org/wiki/Windows_code_page)) to UTF-8 so Jekyll runs without errors. For Ruby 2.0.0, run `chcp 65001` first. For Ruby 1.9.3, you can alternatively do `SET LANG=en_EN.UTF-8`. 3. Open in your browser, and boom! Learn more about using Jekyll by reading its [documentation](http://jekyllrb.com/docs/home/).