40 lines
2.0 KiB
Markdown
40 lines
2.0 KiB
Markdown
---
|
|
title: About Garth
|
|
---
|
|
|
|
A stupidly simple theme for Jekyll, using the official Jekyll theme implementation.
|
|
|
|
- [Fork on GitHub](https://github.com/daviddarnes/garth)
|
|
- [Install Garth](https://github.com/daviddarnes/garth#installation)
|
|
- [Tip me $5](https://www.paypal.me/daviddarnes/5usd)
|
|
|
|
## Installation
|
|
|
|
### As a Jekyll theme
|
|
|
|
1. Add `gem "garth-jekyll-theme"` to your `Gemfile` to add the theme as a dependancy
|
|
2. Run the command `bundle install` in the root of project to install the theme and its dependancies
|
|
3. Add `theme: garth-jekyll-theme` to your `_config.yml` file to set the site theme
|
|
4. Run `bundle exec jekyll serve` to build and serve your site
|
|
5. Done! Use the example [`_config.yml`](https://github.com/daviddarnes/garth/blob/master/_config.yml) file to set site-wide options
|
|
|
|
### As a GitHub Pages remote theme
|
|
|
|
1. Add `gem "jekyll-remote-theme"` to your `Gemfile` to add the theme as a dependancy
|
|
2. Run the command `bundle install` in the root of project to install the jekyll remote theme gem as a dependancy
|
|
3. Add `jekyll-remote-theme` to the list of `plugins` in your `_config.yml` file
|
|
4. Add `remote_theme: daviddarnes/garth` to your `_config.yml` file to set the site theme
|
|
5. Run `bundle exec jekyll serve` to build and serve your site
|
|
6. Done! Use the example [`_config.yml`](https://github.com/daviddarnes/garth/blob/master/_config.yml) file to set site-wide options
|
|
|
|
### As a Boilerplate / Fork
|
|
|
|
_(deprecated, not recommended)_
|
|
|
|
1. [Fork the repo](https://github.com/daviddarnes/garth#fork-destination-box)
|
|
2. Replace the `Gemfile` with one stating all the gems used in your project
|
|
3. Delete the following unnecessary files/folders: `CODE_OF_CONDUCT.md`, `CONTRIBUTING.md`, `LICENSE`, `screenshot.png`, `CNAME` and `garth-jekyll-theme.gemspec`
|
|
4. Run the command `bundle install` in the root of project to install the jekyll remote theme gem as a dependancy
|
|
5. Run `bundle exec jekyll serve` to build and serve your site
|
|
6. Done! Use the example [`_config.yml`](https://github.com/daviddarnes/garth/blob/master/_config.yml) file to set site-wide options
|