Building this site in Github Pages

  • 24th Feb 2018
  • 1 min read

Outdated - this site is not longer hosted on github nor is it using jekyll.

The following are instructions to build this site. Largely it is an exercise in both verifying the steps for myself and in using the site building tools to create and publish this post.

These instructions are based on building a user or organisation site, rather than a project site.

Create initial site

  • Create Repository: kemitix.github.io
  • Browse to the Settings page
  • Scroll down to GitHub Pages
  • Tick Enforce HTTPS

Create local Jekyll project

sudo apt install ruby-dev
sudo gem install jekyll bundler
jekyll new kemitix.github.io
cd kemitix.github.io

Configure So Simple theme

Add plugins to Gemfile:

gem "github-pages", group: :jekyll_plugins

group :jekyll_plugins do
    gem "jekyll-remote-theme"
    gem "jekyll-sitemap"
end

Install plugin:

bundle install

Enable plugins and select theme in _config.yml:

plugins:
  - jekyll-remote-theme
  - jekyll-sitemap
remote_theme: mmistakes/so-simple-theme

Review site locally

bundle exec jekyll serve --incremental

Open browser: http://localhost:4000/

Publish to github

git init
git add .
git commit -m"Initial commit"
git push -u origin master
  • Open browser: https://kemitix.github.io/

Refs

  • http://pages.github.com/
  • https://jekyllrb.com/docs/installation/