Skip to content

dominicpalmer/dominicpalmer.org

Repository files navigation

Personal Site - dominicpalmer.org

License

Summary

This repo is home to my personal website, dominicpalmer.org. It's a fork of a Jekyll theme named Minimal Mistakes, and is hosted with GitHub Pages.

Design

The site is backed by Jekyll, a static site generator. Although static site generation is often aimed at translation of markdown into HTML, I structured page content using HTML from the outset, with SCSS and plain JavaScript for styling and aesthetic features.

To get syntax highlighting of code blocks, I used an awesome framework called highlight.js. The highlighting colour theme used site-wide is gruvbox.

Dependencies

Firstly, you'll need Jekyll's dependencies:

  • Ruby, version 2.5.0+
  • RubyGems
  • GCC and Make (i.e. build-essentials)

Then per Jekyll's docs, you'll need the Jekyll and Bundler gems:

gem install jekyll bundler

Local Build and Deployment

Clone the repo:

git clone https://github.com/dominicpalmer/dominicpalmer.org.git

Then at the repository root:

bundle exec jekyll serve

Scripts

By default, changing structure or styling source files once a local deployment is up and running will trigger a re-generation of the affected resources. Only a page refresh is then needed to see the changes reflected in the browser.

To see changes to scripts reflected in real time, you need to first bundle and minify them. After making a change to anything in ./assets/js, re-build and minify via:

npm run build:js

Or to re-build everything except jQuery:

npm run main:js

Once run, the local server will recognise there has been a change to the source and will re-generate as before.

License

MIT licensed.