2017-01-04 00:41:34 +00:00
# [Garth](https://garth.darn.es/)
2016-06-15 08:47:48 +00:00
[](https://badge.fury.io/rb/garth-jekyll-theme)
2016-06-15 08:48:01 +00:00
2017-01-04 00:41:34 +00:00
A stupidly simple theme for Jekyll, using the official Jekyll theme implementation.
2016-06-19 18:17:19 +00:00
2016-06-15 08:47:48 +00:00
2017-01-04 00:41:34 +00:00
## Contents
- [Installation ](#installation )
- [Site settings ](#site-settings )
- [Page layouts ](#page-layouts )
- [Credits ](#credits )
2016-06-20 08:54:31 +00:00
## Installation
2016-06-15 08:47:48 +00:00
2017-01-04 00:41:34 +00:00
### As a Fork
2016-07-31 16:48:13 +00:00
2017-01-04 00:41:34 +00:00
1. [Fork the repo ](https://github.com/daviddarnes/garth-jekyll-theme#fork-destination-box )
2. Clone down the repo with `$ git clone git@github.com:username/reponame.git`
3. Delete the `demo/` folder and `screenshot.png` files
4. Change the `CNAME` record to your projects' record
5. Install bundler with `$ gem install bundler`
6. Install gems with `$ bundle install`
7. Run Jekyll with `$ bundle exec jekyll serve --watch`
8. Begin hacking for your project
2016-07-29 13:33:14 +00:00
2017-01-04 00:41:34 +00:00
### As a Jekyll 3.3 theme gem
2016-06-20 12:13:55 +00:00
2017-01-04 00:41:34 +00:00
1. Download the starter `/demo` content, [quick download link ](https://minhaskamal.github.io/DownGit/#/home?url=https://github.com/daviddarnes/garth-jekyll-theme/tree/master/demo )
2. Install bundler with `$ gem install bundler`
3. Install gems with `$ bundle install`
4. Run Jekyll with `$ bundle exec jekyll serve --watch`
5. Begin hacking for your project
2016-06-20 12:13:55 +00:00
2017-01-04 00:41:34 +00:00
## Site settings
2016-07-31 16:48:13 +00:00
2017-01-04 00:41:34 +00:00
You'll need to change the `description` , `title` and `url` to match with the project.
2016-06-20 12:13:55 +00:00
2017-01-04 00:41:34 +00:00
## Page layouts
2016-07-31 16:48:13 +00:00
2017-01-04 00:41:34 +00:00
`page` , `post` and `home` (acts as the font page blog).
2016-07-29 13:33:14 +00:00
2017-01-04 00:41:34 +00:00
> **Note:** The Post List Page options are actually in the collection data within the `_config.yml` file.
2016-07-29 13:33:14 +00:00
2017-01-04 00:41:34 +00:00
## Credits
2016-07-29 13:33:14 +00:00
2017-01-04 00:41:34 +00:00
- Thanks to [Sassline ](https://sassline.com/ ) for the typographic basis, by [Jake Giltsoff ](https://twitter.com/jakegiltsoff )
- Thanks to [Flexbox mixin ](https://github.com/mastastealth/sass-flex-mixin ) by [Brian Franco ](https://twitter.com/brianfranco )
- Thanks to [Normalize ](https://necolas.github.io/normalize.css/ ) by [Nicolas Gallagher ](https://twitter.com/necolas ) and [Jonathan Neal ](https://twitter.com/jon_neal ).
- Thanks to [pygments-css ](http://richleland.github.io/pygments-css/ ) for the autumn syntax highlighting, by [Rich Leland ](https://twitter.com/richleland )
