sherlocke.github.io

Official website and development blog for Sherlocke.

Overview

This is a standard Jekyll static site.

Viewing the site locally

You should have Ruby 2.1.x and Python 2.7.x (for Pygments) installed. I recommend using rbenv and pyenv to manage your Ruby & Python installations.

First, you'll need bundler:

gem install bundler

Bundle the required gems:

bundle install

Then clone this repository and serve the site locally:

git clone [email protected]:sherlocke/sherlocke.github.io.git
cd sherlocke.github.io/
jekyll serve

You can use the watch flag when developing to instantly see the changes that you've made.

jekyll serve --watch

NOTE: Changes to config.yml will not be instantly applied; you'll need to restart the server.

Branching

Use the draft branch to make any updates to the website. Whenever you want to publish your changes to the website, merge draft into master and then deploy:

# After making updates, merge `draft` into `master`
git checkout master
git merge draft

# Deploy to GitHub Pages
git push origin master

IMPORTANT: It's okay for commits on draft to contain bugs/issues, but master should always point to a commit that is ready to be published.