Funky: fork of the Garth theme, with a few extra features.
Go to file
David Darnes 4e1a24eef9
Merge pull request #23 from mtlynch/trailing-space
Removing trailing whitespace
2019-03-03 23:57:19 +00:00
_includes Removing trailing whitespace 2019-03-03 16:27:38 -05:00
_layouts Removing trailing whitespace 2019-03-03 16:27:38 -05:00
_posts Changing sample content and dev tweaks 2017-01-04 08:54:39 +00:00
_sass Make sure overrides are happening over sassline 2018-01-01 21:48:08 +00:00
assets Allow use of baseurl, change logo to an internal url, simple graphic placeholder #13 2018-01-01 20:24:41 +00:00
_config.yml Add support for custom favicon 2018-01-17 19:49:52 -05:00
.gitignore Complete revision of code, bringing it up to spec 2017-01-04 00:41:34 +00:00
404.md Complete revision of code, bringing it up to spec 2017-01-04 00:41:34 +00:00
about.md Add installation instructions to demo site 2018-01-01 21:48:27 +00:00
CNAME Amend CNAME record 2017-01-04 01:10:33 +00:00
CODE_OF_CONDUCT.md Add code of conduct and contributing guidelines 2018-01-01 21:30:57 +00:00
CONTRIBUTING.md Add code of conduct and contributing guidelines 2018-01-01 21:30:57 +00:00
garth-jekyll-theme.gemspec Version bump 1.0.2 2018-01-18 22:54:32 +00:00
Gemfile Complete revision of code, bringing it up to spec 2017-01-04 00:41:34 +00:00
index.html Revert layout back again 2018-04-28 18:43:22 +01:00
LICENSE Complete revision of code, bringing it up to spec 2017-01-04 00:41:34 +00:00
README.md Amend docs around customising, thanks @leonelgalan. Fixes #19 2018-04-28 18:15:09 +01:00
screenshot.png Getting the new version up to spec, removing any unwanted code and matching it with the original design 2017-01-04 22:36:30 +00:00

Garth

Gem Version

🥁 A stupidly simple theme for Jekyll, using the official Jekyll theme implementation.

Screenshot

Contents

Installation

As a Jekyll theme

  1. Add gem "garth-jekyll-theme" to your Gemfile to add the theme as a dependancy
  2. Run the command bundle install in the root of project to install the theme and its dependancies
  3. Add theme: garth-jekyll-theme to your _config.yml file to set the site theme
  4. Run bundle exec jekyll serve to build and serve your site
  5. Done! Use the example _config.yml file to set site-wide options

As a GitHub Pages remote theme

  1. Add gem "jekyll-remote-theme" to your Gemfile to add the theme as a dependancy
  2. Run the command bundle install in the root of project to install the jekyll remote theme gem as a dependancy
  3. Add jekyll-remote-theme to the list of plugins in your _config.yml file
  4. Add remote_theme: daviddarnes/garth to your _config.yml file to set the site theme
  5. Run bundle exec jekyll serve to build and serve your site
  6. Done! Use the example _config.yml file to set site-wide options

As a Boilerplate / Fork

(deprecated, not recommended)

  1. Fork the repo
  2. Replace the Gemfile with one stating all the gems used in your project
  3. Delete the following unnecessary files/folders: CODE_OF_CONDUCT.md, CONTRIBUTING.md, LICENSE, screenshot.png, CNAME and garth-jekyll-theme.gemspec
  4. Run the command bundle install in the root of project to install the jekyll remote theme gem as a dependancy
  5. Run bundle exec jekyll serve to build and serve your site
  6. Done! Use the example _config.yml file to set site-wide options

Customising

When using Garth as a theme means you can take advantage of the file overriding method. This allows you to overwrite any file in this theme with your own custom file, simply by matching the file name and path. The most common example of this would be if you want to add your own styles or change the core style settings.

To add your own styles copy the styles.scss into your own project with the same file path (assets/styles.scss). From there you can add your own styles, you can even optionally ignore the theme styles by removing the @import "garth"; line.

If you're just looking to set your own colours copy the _colors.scss and main theme styles file garth.scss into your project at the same file path (_sass/) and change variables however you wish. The settings are a mixture of custom variables and settings from Sassline - follow the link to find out how to configure the typographic settings.

Site settings

You'll need to change the description, title and url to match with the project.

Page layouts

There are 3 layouts; page, post and home (home acts as the font page blog).

Note: The Post List Page options are actually in the collection data within the _config.yml file, this is so they can be edited with CMSs such as Siteleaf

Credits