README.md 916 Bytes
Newer Older
Davide Depau's avatar
Davide Depau committed
1
2
3
4
5
6
7
8
9
10
11
12
Theme based on [Long Haul](https://github.com/brianmaierjr/long-haul)

## Development

1. Install `npm` and Ruby `bundler`
2. Install development dependencies: `./setup_dev.sh`
3. Run development server: `./run_dev.sh`

## Building

1. Ensure Sass files have been built properly: `npm run build-css`
1. Build Jekyll: `bundle exec jekyll build`
brianmaierjr's avatar
brianmaierjr committed
13
14
15
16
17

## Site Settings

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

18
- **title:** title of your site
brianmaierjr's avatar
brianmaierjr committed
19
20
21
- **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
22
- **navigation:** these are the links in the main site navigation
23
24
- **social** diverse social media usernames (optional)
- **google_analytics** Google Analytics key (optional)
brianmaierjr's avatar
brianmaierjr committed
25
26

## License
27

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