This is a sample project to highlight some of the functionality of the Jekyll static web site generator. The content within is only for demonstration purposes, and in reality is just a subset of the Valence UI documentation.
Jekyll relies on Ruby and Node.js to generate a static HTML site from content written in Markdown (or other formats). It runs on Linux, Unix or Mac OSX, and can be fiddled with to run on Windows. Please refer to Jekyll's own Installation Guide to get everything installed and configured.
Once the installation step is complete, to build the project, clone this repo to a directory on your computer:
git clone https://github.com/dlockhart/jekyll-playground.gitGo into the directory and run:
jekyll buildThis will build the project into the _site directory. Again, there's much more information in the Jekyll Usage documentation.
You can also build and host a development version of the site on your local machine, which is useful for previewing your changes before pushing them.
jekyll serveYou can then visit http://localhost:4000/ to see the site. The serve command will automatically rebuild when you make changes to any of the content files. Simply wait for the rebuild to complete (a few seconds) and reload your browser.
This project is set up to be built and tested continuously after each commit using Travis CI. You can see the build status of the latest builds and pull requests here:
https://travis-ci.org/dlockhart/jekyll-playground
Always make sure your pull requests build successfully before merging them into master.
The project is also configured to deploy automatically by Travis CI to its production location, here:
http://design.d2l.s3-website-us-west-2.amazonaws.com/
Deployment does not happen on every commit, but only on tagged commits. The easiest way to do this is through GitHub's create a release workflow.
When naming releases, it's best to use a semantic version number that best describes the type of changes that have occurred since the previous release.