From 1322e204545f84e0f339568ceb6f7e6628d7159a Mon Sep 17 00:00:00 2001 From: Egor Tensin Date: Tue, 8 Mar 2016 05:07:59 +0300 Subject: README update --- README.md | 33 ++++++++++++++++++++------------- 1 file changed, 20 insertions(+), 13 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 1a8e6c6..b2a31cf 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,14 @@ https://egor-tensin.github.io/. [Jekyll](http://jekyllrb.com/) is used to build a set of static HTML pages from a collection of templates and resources. -Jekyll doesn't support Windows, however at the moment of writing one can get it -to work using the excellent tutorial at http://jekyll-windows.juthilo.com/. +It might seem like Jekyll doesn't support Windows very well. +However, at the moment of writing one can get it to work using the excellent +tutorial at http://jekyll-windows.juthilo.com/. +I personally had no problems running Jekyll on Windows whatsoever. -I'm using [Bundler](http://bundler.io/) to set up a development environment. -After the `bundler` gem is installed, project dependencies can be installed by -running +I use [Bundler](http://bundler.io/) to manage project's dependencies. +Make sure you have the `bundler` gem installed; project dependencies can then +be installed by executing bundle install @@ -20,22 +22,19 @@ in the project's root directory. ## Development -To run a local web server, run +To run a local web server, execute bundle exec jekyll serve --watch --config _config.yml,_config_dev.yml -from the project's root directory. +in the project's root directory. You can then review your changes at http://localhost:4000/. -Please note that the support for `--watch`ing for modification on Windows is -kind of iffy at the moment of writing. -One possible workaround is to add `--force_polling` to `jekyll`s options: +If you can't get Jekyll to properly `--watch` for file modifications on +Windows, try adding `--force_polling` to `jekyll`s options: bundle exec jekyll serve --watch --force_polling --config _config.yml,_config_dev.yml -It might still not work though, so you might end up having to re-run `jekyll` -manually. -For details, refer to http://jekyll-windows.juthilo.com/4-wdm-gem/. +It might still not work though, but you can always re-run `jekyll` manually. Note that `_config_dev.yml` is included to rewrite some of the `site` fields from `_config.yml` during development. @@ -45,6 +44,14 @@ In particular, it of external CSS stylesheets and JavaScript files are included instead of the `min`ified versions. +## Accessing via file:// + +Jekyll doesn't provide native support for generating a static website which can +be viewed without a web server. +One easy workaround might be to `wget` the website and convert the links: + + wget -k -r http://localhost:4000/ + ## Licensing This project, including all of the files and their contents, is licensed under -- cgit v1.2.3