2017 © Pedro Peláez
 

silverstripe-module silverstripe-githubshortcode

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

image

webbuilders-group/silverstripe-githubshortcode

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

  • Tuesday, November 21, 2017
  • by WebbuildersGroup
  • Repository
  • 4 Watchers
  • 1 Stars
  • 6 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 1 Forks
  • 1 Open issues
  • 7 Versions
  • 0 % Grown

The README.md

GitHub Short Code

Add a short code for adding GitHub Star and Fork buttons with counts to a HTMLText field., (*1)

Maintainer Contact

Requirements

  • SilverStripe CMS 4.x | 5.x

Installation

  • Run composer require webbuilders-group/silverstripe-githubshortcode dev-master in the project folder
  • Run dev/build?flush=all to regenerate the manifest

Usage

Usage is pretty straight forward to add GitHub buttons you simply add the following:, (*2)

[github repo="repository owner/repository name"]

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., (*3)

[github repo="repository owner/repository name" layout="stacked"]

[github repo="repository owner/repository name" layout="stacked" button="stars"]

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):, (*4)

[github,repo="repository owner/repository name",layout="stacked",button="stars"]

Configuration Options

There are a few configuration options available to you:, (*5)

WebbuildersGroup\GitHubShortCode\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

The Versions

21/11 2017

dev-master

9999999-dev

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

  Sources   Download

BSD-3-Clause

The Requires

 

silverstripe github shortcode

21/11 2017

2.0.0

2.0.0.0

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

  Sources   Download

BSD-3-Clause

The Requires

 

silverstripe github shortcode

23/03 2016

1.0.0.x-dev

1.0.0.9999999-dev

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

  Sources   Download

BSD-3-Clause

The Requires

 

silverstripe github shortcode

23/03 2016

1.0.x-dev

1.0.9999999.9999999-dev

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

  Sources   Download

BSD-3-Clause

The Requires

 

silverstripe github shortcode

23/03 2016

1.0.0

1.0.0.0

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

  Sources   Download

BSD-3-Clause

The Requires

 

silverstripe github shortcode

02/03 2014

0.1.1

0.1.1.0

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

  Sources   Download

BSD-3-Clause

The Requires

 

silverstripe github shortcode

18/12 2013

0.1

0.1.0.0

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

  Sources   Download

BSD-3-Clause

The Requires

 

silverstripe github shortcode