Add a short code for adding GitHub Star and Fork buttons with counts to a HTMLText field.


Repository: https://github.com/webbuilders-group/silverstripe-githubshortcode

Packagist: http://packagist.org/packages/webbuilders-group/silverstripe-githubshortcode

Issues: https://github.com/webbuilders-group/silverstripe-githubshortcode/issues

Authors: Ed Chipman

1 1 1


Readme

GitHub Short Code

Add a short code for adding GitHub Star and Fork buttons with counts to a HTMLText field.

Maintainer Contact

Requirements

  • SilverStripe CMS 3.x

Installation

Usage

Usage is pretty straight forward to add GitHub buttons you simply add the following:

N/A

Optionally you may add layout="stacked" to use a stacked layout (defaults to inline). As well you may also optionally add button="stars" or button="forks" (defaults to both) to only show the star gazers or forks of the repository.

N/A

N/A

In 3.1 the short codes above will work as included however the updated syntax for the short code would be (of course layout and button are not required):

N/A

Configuration Options

There are a few configuration options available to you:

GitHubShortCode:
    CacheTime: 86400 #Cache time in seconds (default is 1 day, remember the GitHub api is rate limited)
    UseBasicAuth: false #Use GitHub authentication or not
    Username: "your username" #GitHub Username, required if using authentication
    Password: "your password" #GitHub Password, required if using authentication
    UseShortHandNumbers: true #Use short hand numbers i.e 5.6K or not

Versions

dev-master
2016-03-23 12:33pm UTC
BSD-3-Clause

Install composer require webbuilders-group/silverstripe-githubshortcode dev-master

Manual Install: Download

Requires
  • silverstripe/framework: 3.*
  • composer/installers: *
0.1.1
2014-03-02 6:18pm UTC
BSD-3-Clause

Install composer require webbuilders-group/silverstripe-githubshortcode 0.1.1

Manual Install: Download

Requires
  • silverstripe/framework: 3.*
  • composer/installers: *
0.1
2013-12-18 2:04pm UTC
BSD-3-Clause

Install composer require webbuilders-group/silverstripe-githubshortcode 0.1

Manual Install: Download

Requires
  • silverstripe/framework: 3.*
  • composer/installers: *