funky/README.md

Garth

🥁 A stupidly simple theme for Jekyll, using the official Jekyll theme implementation.

Contents

• Installation
• Site settings
• Page layouts
• Credits

Installation

As a Fork

1. Fork the repo
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

As a Jekyll 3.3 theme gem

1. Download the starter /demo content, quick download link
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

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