|
|
@@ -1,8 +1,9 @@
|
|
|
|
# [Garth](https://garth.darn.es/)
|
|
|
|
# [Funky](https://garth.darn.es/)
|
|
|
|
[](https://badge.fury.io/rb/garth-jekyll-theme)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
🥁 A really basic theme for Jekyll, using the official Jekyll theme implementation.
|
|
|
|
🥁 A really basic theme for Jekyll, using the official Jekyll theme implementation.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[<img src="https://cdn.buymeacoffee.com/buttons/default-yellow.png" width="217"/>](https://buymeacoffee.com/daviddarnes#support)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Contents
|
|
|
|
## Contents
|
|
|
@@ -14,6 +15,16 @@
|
|
|
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
## Installation
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### Quick setup
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
To give you a running start I've put together some starter kits that you can download, fork or even deploy immediately:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
- Vanilla Jekyll starter kit:
|
|
|
|
|
|
|
|
[](https://app.netlify.com/start/deploy?repository=https://github.com/daviddarnes/garth-kit)
|
|
|
|
|
|
|
|
- Stackbit starter kit:
|
|
|
|
|
|
|
|
[](https://app.stackbit.com/create?theme=https://github.com/daviddarnes/garth-stackbit-kit)
|
|
|
|
|
|
|
|
- GitHub Pages with remote theme kit - **[Download kit](https://github.com/daviddarnes/garth-kit/archive/remote-theme.zip)**
|
|
|
|
|
|
|
|
|
|
|
|
### As a Jekyll theme
|
|
|
|
### As a Jekyll theme
|
|
|
|
|
|
|
|
|
|
|
|
1. Add `gem "garth-jekyll-theme"` to your `Gemfile` to add the theme as a dependancy
|
|
|
|
1. Add `gem "garth-jekyll-theme"` to your `Gemfile` to add the theme as a dependancy
|
|
|
@@ -31,17 +42,6 @@
|
|
|
|
5. Run `bundle exec jekyll serve` to build and serve your site
|
|
|
|
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
|
|
|
|
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
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Customising
|
|
|
|
## Customising
|
|
|
|
|
|
|
|
|
|
|
|
When using Garth as a theme means you can take advantage of the file overriding method. This allows you to overwrite any file in this theme with your own custom file, by matching the file name and path. The most common example of this would be if you want to add your own styles or change the core style settings.
|
|
|
|
When using Garth as a theme means you can take advantage of the file overriding method. This allows you to overwrite any file in this theme with your own custom file, by matching the file name and path. The most common example of this would be if you want to add your own styles or change the core style settings.
|
|
|
|
Atlas48
David DarnesandGitHub