View on GitHub

Grand Opening

☛ August 17, 2013 ❝Grand Opening❞

Categorized documentation ≀ Tagged how.to github jekyll

Setting up my github pages

Well, this was moderately easy, by combining WDW's jekyll-boilerplate project template for Jekyll with one of the github standard themes.

Here's a rough outline of the necessary steps:

Copy jekyll-boilerplate into your »accountname«.github.io repository.
Save the content of index.html.
Overwrite this with one of the standard templates, as described here.
git pull the theme you just saved.
Merge the new index.html with _layouts/default.html (i.e. copy the contents, and insert the existing template markup at the appropriate places).
Restore the index.html saved from jekyll-boilerplate.
Change images and stylesheets URLs to be server-absolute, else blog posts won't render correctly. This was at least necessary for the theme I chose, and might not apply to others.

And then what you see here is what you'll get.

Locally serving your site

To avoid the up to 10 minute delay of the github publishing queue, you can install Jekyll locally as root:

apt-get install ruby1.9.1 # on Ubuntu 12.04, your distro may vary
gem install jekyll
gem install rdiscount

Then within your git working directory, start an auto-refreshing Jekyll server process using…

jekyll serve --watch >jekyll.log 2>&1 &

Or even better, copy my jekyll-serve.sh script to your project, and just call ./jekyll-serve.sh start.

Now, just save any changes to your posts or layouts, and then reload the instantly rendered result in your browser, pointed at http://localhost:4000/.

☛ August 17, 2013 ❝Grand Opening❞

Setting up my github pages

Locally serving your site

Further reading