These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
- Clone this repository to your local machine.
- Build and serve the site using jekyll:
bundle exec jekyll serve
Any changes made to any page will then be compiled and displayed live on your localhost.
What things you need to install the software and how to install them
- Your preferred (web-dev) code editor - e.g. Brackets, VS Code, Vim.
- Jekyll https://jekyllrb.com/docs/installation/ Note: Windows devs are recommended to first install and set up Windows Subsystem for Linux (WSL) for smoother development. Refer to Michael Treat's guide for an explanation and walkthrough of WSL.
- 2 space indentation
- Liquid code should have 1 space between the start and the end of the tag. For example,
{% for x in list %}, not{%for x in list %}. Likewise,{{ person.name }}not{{person.name}}.
- Per-page Custom CSS - JReel
- Jekyll Style Guide - Ben Balter
- Jekyll Tips and Best Practices - JReel
- Jekyll Collections
- Prose - Web editor for static sites on Github Pages
Github Pages builds and deploys our website automatically from master. We will never commit directly to master, only ever merge changes from other branches after review.