funky/README.md

43 lines
1.2 KiB
Markdown
Raw Normal View History

2016-06-20 08:54:31 +00:00
# Garth Jekyll Theme
2016-06-15 08:48:01 +00:00
[![Gem Version](https://badge.fury.io/rb/garth-jekyll-theme.svg)](https://badge.fury.io/rb/garth-jekyll-theme)
2016-06-15 08:48:01 +00:00
2016-06-19 18:19:46 +00:00
A stupidly simple theme for Jekyll (3.2), using official Jekyll theme implementation.
![Screenshot](https://raw.githubusercontent.com/daviddarnes/garth-jekyll-theme/master/screenshot.png)
2016-06-20 08:54:31 +00:00
## Installation
2016-06-20 08:54:31 +00:00
1. `$ gem install garth-jekyll-theme`
2. `$ gem install github-pages`
3. `$ gem install jekyll -v 3.2.0.pre.beta1`
4. Add the following to your config file:
2016-06-19 18:02:00 +00:00
``` yml
2016-06-19 18:00:34 +00: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 12:12:39 +00:00
5. Add the following to your `css/styles.scss` file:
``` css
---
---
@import "theme";
```
6. Add the following to your `js/scripts.js` file:
``` html
---
---
{% include theme.js %}
```
2016-06-20 08:54:31 +00:00
5. `$ jekyll _3.2.0.pre.beta1_ serve --watch`