Oatcake

This is Oatcake, the GitHub Pages theme that I use on seanh.cc. Theme demo site: https://www.seanh.cc/jekyll-theme-oatcake/

Running Locally

See also: GitHub's instructions for running a GitHub Pages site locally using the GitHub Pages gem.

To install and run this theme and demo site locally:

1. Install Ruby (2.1 or newer), Bundler and git:

   sudo apt install ruby bundler git
   

2. Clone this repo and cd into it:

   git clone https://github.com/seanh/jekyll-theme-oatcake.git
   cd jekyll-theme-oatcake
   

3. Install Jekyll and other dependencies:

   bundle install --path vendor/bundle
   

4. Finally, serve the site at http://localhost:4000/jekyll-theme-oatcake/:

    bundle exec jekyll serve
   

You should run bundle-update now and then to keep up to date with the GitHub Pages gem.

Publishing a Release

Just create a new tag and GitHub release.

GitHub Pages sites can then upgrade to the new version by bumping the version number in their _config.yml files: remote_theme: seanh/jekyll-theme-oatcake@X.Y.Z

See the jekyll-remote-theme plugin that GitHub Pages uses for building sites with GitHub-hosted themes.