The website at
is served via GitHub Pages.
Jekyll is used for building it. GitHub has an integrated Jekyll feature. That is not used. Jekyll is used in the development environment and the built website is checked in to the repository.
In GitHub Pages, websites for projects are stored in a separate
WYMeditor’s website is developed in the
and is built and published to the
as part of each release.
This promotes consistency. It also allows us to serve the demos/examples via GitHub Pages.
The website’s only page is the
README.rst file, converted to HTML.
This occurs automatically in builds.
The theme is a ported version of a GitHub Pages layout.
The Jekyll layout is at
Its media and styles are located in
Environment for development of the website¶
There is no Jekyll configuration file,
Instead, Grunt orchestrates building and serving.
Configuration is within the
The following will install Jekyll. In this example, RVM is used.
$ rvm install 2.2
$ bundle install
Docutils is also required. Docutils is probably available in your Linux
python-docutils. In particular, it
is required that
rst2html be globally available.
Previewing the website locally¶
The website is served in development by running:
$ grunt server
It is then available at
While this is running, changes to any of the contents of the website’s directory result in automatic rebuilding of the website. LiveReload is implemented.
Building the website¶
The website is built as part of the entire project build:
$ grunt build
$ grunt jekyllDist
It gets built to
dist/website, which should then be committed.
Publishing the website¶
Publishing the website is a matter of pushing to the
$ git push origin master:gh-pages
This should be done during the process of making a release. Doing it between releases will result in broken download links in the website.