Documentation

The documentation is built with Jekyll, which integrates with Github Pages.

Ruby and Jekyll must be installed first to run the documentation server during development. Then install Jekyll’s dependencies:

$ cd doc
$ bundle install

To serve the documentation using Jekyll’s web server during development:

$ cd doc
$ bundle exec jekyll serve

To generate the static site:

$ cd doc
$ bundle exec jekyll build

Any updates to the files under docs/ triggers a rebuild of the site via the pages-build-deployment workflow on Github. These changes are reflected at windowjs.org after a few seconds.

Updating

To update Jekyll’s dependencies:

$ cd doc
$ bundle update

Then run the server again and verify that the pages render as expected, and commit the updated Gemfile.lock file.