Funky: fork of the Garth theme, with a few extra features.
_includes | ||
_layouts | ||
_posts | ||
_sass | ||
assets | ||
_config.yml | ||
.gitignore | ||
404.md | ||
about.md | ||
CNAME | ||
garth-jekyll-theme.gemspec | ||
Gemfile | ||
index.html | ||
LICENSE | ||
README.md | ||
screenshot.png |
Garth
🥁 A stupidly simple theme for Jekyll, using the official Jekyll theme implementation.
Contents
Installation
As a Jekyll theme
- Add
gem "garth-jekyll-theme"
to yourGemfile
to add the theme as a dependancy - Run the command
bundle install
in the root of project to install the theme and its dependancies - Add
theme: garth-jekyll-theme
to your_config.yml
file to set the site theme - Run
bundle exec jekyll serve
to build and serve your site - Done! Use the example
_config.yml
file to set site-wide options
As a GitHub Pages remote theme
- Add
gem "jekyll-remote-theme"
to yourGemfile
to add the theme as a dependancy - Run the command
bundle install
in the root of project to install the jekyll remote theme gem as a dependancy - Add
jekyll-remote-theme
to the list ofplugins
in your_config.yml
file - Add
remote_theme: daviddarnes/garth
to your_config.yml
file to set the site theme - Run
bundle exec jekyll serve
to build and serve your site - Done! Use the example
_config.yml
file to set site-wide options
As a Boilerplate / Fork
(deprecated, not recommended)
- Fork the repo
- Replace the
Gemfile
with one stating all the gems used in your project - Delete the following unnecessary files/folders:
CODE_OF_CONDUCT.md
,CONTRIBUTING.md
,LICENSE
,screenshot.png
,CNAME
andgarth-jekyll-theme.gemspec
- Run the command
bundle install
in the root of project to install the jekyll remote theme gem as a dependancy - Run
bundle exec jekyll serve
to build and serve your site - Done! Use the example
_config.yml
file to set site-wide options
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
- Thanks to Sassline for the typographic basis, by Jake Giltsoff
- Thanks to Flexbox mixin by Brian Franco
- Thanks to Normalize by Nicolas Gallagher and Jonathan Neal.
- Thanks to pygments-css for the autumn syntax highlighting, by Rich Leland