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

Brian Maier Jr's avatar
Brian Maier Jr committed
3
Long Haul is a minimal jekyll theme built with SASS / GULP / BROWSERSYNC / AUTOPREFIXER and focuses on long form blog posts. It is meant to be used as a starting point for a jekyll blog/website.
4

Antoine Cotten's avatar
Antoine Cotten committed
5
If you really enjoy Long Haul and want to give me credit somewhere on the internet send or tweet out your experience with Long Haul and tag me [@brianmaierjr](https://twitter.com/brianmaierjr).
brianmaierjr's avatar
brianmaierjr committed
6

Brian Maier Jr's avatar
Brian Maier Jr committed
7
#### [View Demo](http://brianmaierjr.com/long-haul)
brianmaierjr's avatar
brianmaierjr committed
8
9
10
11

## Features

- Minimal, Type Focused Design
12
- Built with GULP + SASS + BROWSERSYNC + AUTOPREFIXER
brianmaierjr's avatar
brianmaierjr committed
13
14
15
16
17
18
19
20
21
22
23
- 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
24

brianmaierjr's avatar
brianmaierjr committed
25
26
27
1. [Install Jekyll](http://jekyllrb.com)
2. Fork the [Long Haul repo](http://github.com/brianmaierjr/long-haul)
3. Clone it
aochuih's avatar
aochuih committed
28
29
4. [Install Bundler](http://bundler.io/)
5. Run `bundle install`
Brian Maier Jr's avatar
Brian Maier Jr committed
30
6. Install gulp dependencies by running `npm install`
31
7. Run Jekyll and watch files by running `bundle exec gulp`
Brian Maier Jr's avatar
Brian Maier Jr committed
32
8. Customize and watch the magic happen!
brianmaierjr's avatar
brianmaierjr committed
33
34
35
36
37

## Site Settings

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

38
- **title:** title of your site
brianmaierjr's avatar
brianmaierjr committed
39
40
41
- **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
42
- **navigation:** these are the links in the main site navigation
43
44
- **social** diverse social media usernames (optional)
- **google_analytics** Google Analytics key (optional)
brianmaierjr's avatar
brianmaierjr committed
45
46

## License
47

Brian Maier Jr.'s avatar
Brian Maier Jr. committed
48
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.