2016-06-20 04:54:31 -04:00
|
|
|
# Garth Jekyll Theme
|
2016-06-15 04:48:01 -04:00
|
|
|
|
2016-06-15 04:47:48 -04:00
|
|
|
[![Gem Version](https://badge.fury.io/rb/garth-jekyll-theme.svg)](https://badge.fury.io/rb/garth-jekyll-theme)
|
2016-06-15 04:48:01 -04:00
|
|
|
|
2016-06-19 14:19:46 -04:00
|
|
|
A stupidly simple theme for Jekyll (3.2), using official Jekyll theme implementation.
|
2016-06-19 14:17:19 -04:00
|
|
|
|
|
|
|
![Screenshot](https://raw.githubusercontent.com/daviddarnes/garth-jekyll-theme/master/screenshot.png)
|
2016-06-15 04:47:48 -04:00
|
|
|
|
2016-06-20 04:54:31 -04:00
|
|
|
## Installation
|
2016-06-15 04:47:48 -04:00
|
|
|
|
2016-06-20 04:54:31 -04:00
|
|
|
1. `$ gem install garth-jekyll-theme`
|
|
|
|
2. `$ gem install github-pages`
|
|
|
|
3. `$ gem install jekyll -v 3.2.0.pre.beta1`
|
2016-06-15 04:47:48 -04:00
|
|
|
4. Add the following to your config file:
|
2016-06-20 08:13:55 -04:00
|
|
|
|
2016-06-19 14:02:00 -04:00
|
|
|
``` yml
|
2016-06-19 14:00:34 -04:00
|
|
|
theme: garth-jekyll-theme # Set the theme
|
|
|
|
logo: https://www.gravatar.com/avatar/6c0377abcf4da91cdd35dea4554b2a4c?s=300 # Provide an avatar/logo
|
|
|
|
color: "#ffffff" # Set a theme color
|
|
|
|
paginate: 8 # Set a pagination number for jekyll-paginate
|
|
|
|
|
|
|
|
# Required gems
|
|
|
|
gems:
|
|
|
|
- jekyll-seo-tag # Allow the use of {% seo %} on all pages and posts
|
|
|
|
- jekyll-paginate # Add post pagination
|
|
|
|
|
|
|
|
# Typical site settings
|
|
|
|
title: "Website title"
|
|
|
|
description: "Website description"
|
|
|
|
```
|
2016-06-20 08:13:55 -04:00
|
|
|
|
2016-06-20 08:12:39 -04:00
|
|
|
5. Add the following to your `css/styles.scss` file:
|
2016-06-20 08:13:55 -04:00
|
|
|
|
2016-06-20 08:12:39 -04:00
|
|
|
``` css
|
|
|
|
---
|
|
|
|
---
|
|
|
|
@import "theme";
|
|
|
|
```
|
2016-06-20 08:13:55 -04:00
|
|
|
|
2016-06-20 08:12:39 -04:00
|
|
|
6. Add the following to your `js/scripts.js` file:
|
2016-06-20 08:13:55 -04:00
|
|
|
|
2016-06-20 08:12:39 -04:00
|
|
|
``` html
|
|
|
|
---
|
|
|
|
---
|
|
|
|
{% include theme.js %}
|
|
|
|
```
|
2016-06-20 08:13:55 -04:00
|
|
|
|
|
|
|
7. `$ jekyll _3.2.0.pre.beta1_ serve --watch`
|