-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
71 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,72 @@ | ||
# jekyll-minifier [![Build Status](https://travis-ci.org/uta-org/jekyll-patreon.svg?branch=master)](https://travis-ci.org/uta-org/jekyll-patreon) [![Gem Version](https://badge.fury.io/rb/jekyll-patreon.svg)](http://badge.fury.io/rb/jekyll-patreon) | ||
# jekyll-patreon [![Build Status](https://travis-ci.org/uta-org/jekyll-patreon.svg?branch=master)](https://travis-ci.org/uta-org/jekyll-patreon) [![Gem Version](https://badge.fury.io/rb/jekyll-patreon.svg)](http://badge.fury.io/rb/jekyll-patreon) | ||
|
||
Requires Ruby 2.3+ | ||
Requires Ruby 2.3+ and Jekyll +3.0 | ||
|
||
> A Jekyll plugins that adds Patreon support in your blog to easily embed a widget with goals | ||
## Features | ||
|
||
* Supports several designs: default, fancy, minimal, streamlined, reversed, swapped | ||
* Supports several colors: red, green, orange, red nostripes, green nostripes, orange nostripes, blue nostripes | ||
|
||
## Installation | ||
|
||
Add this line to your site's Gemfile: | ||
|
||
```ruby | ||
gem 'jekyll-patreon' | ||
``` | ||
|
||
Add this configuration to your _config.yml file: | ||
|
||
```yaml | ||
#################### | ||
# Patreon Settings # | ||
#################### | ||
|
||
patreon: | ||
enabled: true | ||
design: 'default' # Supports the following desings: default, fancy, minimal, streamlined, reversed, swapped | ||
title: 'Example title' | ||
metercolor: 'green' # Supports the following colors: red, green, orange, red nostripes, green nostripes, orange nostripes, blue nostripes | ||
toptext: 'Example top text' # Text that appears in before the progress bar (optional) | ||
bottomtext: 'Example bottom text' # Text that appears in after the progress bar (optional) | ||
showgoaltext: true # Display the goal text? | ||
showbutton: true # Display the "Become a patron" button? | ||
``` | ||
## Usage | ||
Simply just put the following tag where you need this: | ||
`{% patreon username %}` | ||
|
||
**Example:** (In my case) | ||
|
||
`{% patreon z3nth10n %}` | ||
|
||
## Issues | ||
|
||
Having issues? Just report in [the issue section](https://github.com/uta-org/jekyll-patreon/issues). **Thanks for the feedback!** | ||
|
||
## Contribute | ||
|
||
Fork this repository, make your changes and then issue a pull request. If you find bugs or have new ideas that you do not want to implement yourself, file a bug report. | ||
|
||
## Donate | ||
|
||
Become a patron, by simply clicking on this button (**very appreciated!**): | ||
|
||
[![](https://c5.patreon.com/external/logo/become_a_patron_button.png)](https://www.patreon.com/z3nth10n) | ||
|
||
... Or if you prefer a one-time donation: | ||
|
||
[![](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://paypal.me/z3nth10n) | ||
|
||
**THANKS TO ALL DONATORS!!** | ||
|
||
## Copyright | ||
|
||
Copyright (c) 2019 z3nth10n (United Teamwork Association). | ||
|
||
License: MIT |