Skip to content

gpoliko/jekyll-boilerplate

Repository files navigation

Jekyll Boilerplate

My Jekyll boilerplate for a simple blog site for documenting my personal learning journey. Utilizing the minimal-mistakes-jekyll theme.


NOTE BEFORE PROCEEDING:

I am still navigating Jekyll, the Liquid templating language and the minimal-mistakes-jekyll theme, so this boilerplate will be incredibly basic. For more configuration info, please see the Useful info section.


Here is a demo of the site.


Contents

  1. Install Ruby (Pre-requisite)
  2. Getting Started
  3. Useful info

Install Ruby

This project requires Ruby to be installed on your system. Install Ruby via your terminal or command line. For Windows installation, you will need to download the Ruby Installer.

Don't worry, be super 🦸‍♂️

🦸‍♂️ Linux (Debian/Ubuntu) super command:

sudo apt-get install ruby-full

🦸‍♂️ macOS super command:

brew install ruby

🦸‍♂️ Windows super sidekick:

https://rubyinstaller.org/


Getting Started

🦸‍♂️ Being super again, click here: Use this template. This will allow you to create a repo using this boilerplate as a template.

Features included in this boilerplate:

  • Sample Home page
  • Sample about page.
  • Sample Contact page.
  • Sample 404 page.
  • Sample posts.
  • Sample navigation.
  • Sample sidebar with social links.
  • Sample footer with social links.
  • Shielded Site included (Relevant to New Zealand).
  • Site wide search.

Simply replace the sample content with your own and begin adding your own pages and posts.


Useful Info


References

Jekyll

Theme by Minimal Mistakes

GitHub Pages