README.md 1.49 KB
Newer Older
brianmaierjr's avatar
brianmaierjr committed
1
![preview Long Haul](/preview.jpg)
2

brianmaierjr's avatar
brianmaierjr committed
3
Long Haul is a minimal jekyll theme built with COMPASS / SASS / SUSY and focuses on long form blog plosts. It is meant to used as a starting point for a jekyll blog/website.
4

brianmaierjr's avatar
brianmaierjr committed
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
If you really enjoy Long Haul and want to give me credit somewhere on the send or tweet out your experience with Long Haul and tag me [@brianmaierjr](https://twitter.com/brianmaier).

####[View Demo](http://brianmaierjr.com/long-haul)

## Features

- Minimal, Type Focused Design
- Built with SASS + COMPASS
- Layout with SUSY Grid
- SVG Social Icons
- Responsive Nav Menu
- XML Feed for RSS Readers
- Contact Form via Formspree
- 5 Post Loop with excerpt on Home Page
- Previous / Next Post Navigation
- Estimated Reading Time for posts
- Stylish Drop Cap on posts
- A Better Type Scale for all devices

## Setup
25

brianmaierjr's avatar
brianmaierjr committed
26
27
28
29
30
31
32
33
34
35
36
1. [Install Jekyll](http://jekyllrb.com)
2. Fork the [Long Haul repo](http://github.com/brianmaierjr/long-haul)
3. Clone it
4. Run Jekyll `jekyll serve -w`
5. Run `compass watch`
6. Customize!

## Site Settings

The main settings can be found inside the `_config.yml` file:

37
- **title:** title of your site
brianmaierjr's avatar
brianmaierjr committed
38
39
40
- **description:** description of your site
- **url:** your url
- **paginate:** the amount of posts displayed on homepage
Brian Maier Jr.'s avatar
Brian Maier Jr. committed
41
- **navigation:** these are the links in the main site navigation
42
- **social** diverse social media usernames
brianmaierjr's avatar
brianmaierjr committed
43
44

## License
45

Brian Maier Jr.'s avatar
Brian Maier Jr. committed
46
This is [MIT](LICENSE) with no added caveats, so feel free to use this Jekyll theme on your site without linking back to me or using a disclaimer.