Funky: fork of the Garth theme, with a few extra features.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Atlas Cove 1b337739a6 Update 'README.md' 11 months ago
.github Update sponsor link 2 years ago
_includes Clean up indentation 2 years ago
_layouts Merge pull request #21 from mtlynch/no-exec 3 years ago
_posts Remove potentially offensive wording 3 years ago
_sass Disabling execute permission on all files 3 years ago
assets Disabling execute permission on all files 3 years ago
.gitignore Complete revision of code, bringing it up to spec 5 years ago
404.md Disabling execute permission on all files 3 years ago
CNAME Disabling execute permission on all files 3 years ago
Gemfile Disabling execute permission on all files 3 years ago
LICENSE Remove potentially offensive wording 3 years ago
README.md Update 'README.md' 11 months ago
_config.yml Remove potentially offensive wording 3 years ago
about.md Add new donate button to about page 2 years ago
garth-jekyll-theme.gemspec Version bump 1.0.5 2 years ago
index.html Disabling execute permission on all files 3 years ago
screenshot.png Getting the new version up to spec, removing any unwanted code and matching it with the original design 5 years ago

README.md

Funky

🥁 A really basic theme for Jekyll, using the official Jekyll theme implementation.

Screenshot

Contents

Installation

Quick setup

To give you a running start I've put together some starter kits that you can download, fork or even deploy immediately:

  • Vanilla Jekyll starter kit:
    Deploy to Netlify
  • Stackbit starter kit:
    Create with Stackbit
  • GitHub Pages with remote theme kit - Download kit

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

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, 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 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