Jekyll Boilerplate

Getting Started

Add the following to your Gemfile:

gem "fenton-jekyll-boilerplate", "~> 0.0.15"
gem "fenton-jekyll-plugin", "~> 0.0.13"

Add the following to your _config.yml:

theme: fenton-jekyll-boilerplate
plugins:
  - fenton-jekyll-plugin

Run bundler before you run jekyll serve.

The full configuration file is available on GitHub.

The basic configuration changes to make are:

  1. Edit _config.yml
  2. Add your icons to /assets/icons/

Additional Files and Folders

You can download the latest starter pack by selecting the latest run and clicking on “starter-pack” in the artefacts.

  • _authors/: Sample author data, which you can replace / extend
  • articles/: This contains the list page that supports pages lists of articles

Jekyll version < 4.3.0

  • _data/language.yml: Only required for versions of Jekyll prior to 4.3.0 - contains translations for the UI

Adjusting the Theme

You can then edit the CSS variables in /assets/css/vars.css, or completely replace the stylesheets. We strongly recommend sticking with the supplied HTML and using your CSS chops to make style changes.

Writing Content

Check out the custom front matter to see how you can control how content is displayed in navigation. You can set short-titles and section titles for menu items.

Running the Jekyll Boilerplate Code

If you want to download the code in the Jekyll Boilerplate repository on GitHub, follow these steps after downloading the code: