Compare commits

...

5 Commits

Author SHA1 Message Date
Atlas Cove 1b337739a6 Update 'README.md' 2021-06-19 15:01:36 +00:00
David Darnes 32fa37c451
Add new donate button to about page 2020-11-22 18:59:58 +00:00
David Darnes 75508c746d
Add donate button 2020-11-22 18:59:17 +00:00
David Darnes d9a0cf4036
Update sponsor link 2020-11-22 18:58:37 +00:00
David Darnes 5f0c8fab20
Add instant deploy buttons for Netlify and Stackbit 2020-07-03 14:46:02 +01:00
3 changed files with 16 additions and 15 deletions

2
.github/FUNDING.yml vendored
View File

@ -1 +1 @@
custom: https://www.paypal.me/daviddarnes/5usd
custom: https://buymeacoffee.com/daviddarnes#support

View File

@ -1,8 +1,9 @@
# [Garth](https://garth.darn.es/)
[![Gem Version](https://badge.fury.io/rb/garth-jekyll-theme.svg)](https://badge.fury.io/rb/garth-jekyll-theme)
# [Funky](https://garth.darn.es/)
🥁 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)
![Screenshot](https://raw.githubusercontent.com/daviddarnes/garth/master/screenshot.png)
## Contents
@ -14,6 +15,16 @@
## 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:
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/daviddarnes/garth-kit)
- Stackbit starter kit:
[![Create with Stackbit](https://assets.stackbit.com/badge/create-with-stackbit.svg)](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
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
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
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.

View File

@ -6,7 +6,8 @@ A really basic 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)
[<img src="https://cdn.buymeacoffee.com/buttons/default-yellow.png" width="217"/>](https://buymeacoffee.com/daviddarnes#support)
## Installation