elmasse / github-buttons

Showcase any GitHub repo's success with these two simple, static buttons featuring dynamic watch and fork counts.

GitHub Buttons

Showcase your GitHub (repo's) success with these three simple, static buttons featuring dynamic watch, fork and follower counts and a link to your GitHub repo or profile page.

To get started, checkout http://ghbtns.com!

Usage

These buttons are hosted via GitHub Pages, meaning all you need to do is include an iframe and you're set. Once included, you can configure it with various options. Here's the include:

<iframe src="http://ghbtns.com/github-btn.html?user=USERNAME&repo=REPONAME&type=BUTTONTYPE"
  allowtransparency="true" frameborder="0" scrolling="0" width="62" height="20"></iframe>

Requirements

user
GitHub username that owns the repo

repo
GitHub repository to pull the forks and watchers counts

type
Type of button to show: watch, fork, or follow

Optional

count
Show the optional watchers or forks count: none by default or true

size
Optional flag for using a larger button: none by default or large

Examples

Basic Watch button

<iframe src="http://ghbtns.com/github-btn.html?user=mdo&repo=github-buttons&type=watch"
  allowtransparency="true" frameborder="0" scrolling="0" width="62" height="20"></iframe>

Basic Fork button

<iframe src="http://ghbtns.com/github-btn.html?user=mdo&repo=github-buttons&type=fork"
  allowtransparency="true" frameborder="0" scrolling="0" width="53" height="20"></iframe>

Basic Follow button

<iframe src="http://ghbtns.com/github-btn.html?user=mdo&type=follow"
  allowtransparency="true" frameborder="0" scrolling="0" width="132" height="20"></iframe>

Watch with count

<iframe src="http://ghbtns.com/github-btn.html?user=mdo&repo=github-buttons&type=watch&count=true"
  allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe>

Fork with count

<iframe src="http://ghbtns.com/github-btn.html?user=mdo&repo=github-buttons&type=fork&count=true"
  allowtransparency="true" frameborder="0" scrolling="0" width="95" height="20"></iframe>

Follow with count

<iframe src="http://ghbtns.com/github-btn.html?user=mdo&type=follow&count=true"
  allowtransparency="true" frameborder="0" scrolling="0" width="165" height="20"></iframe>

Large Watch button with count

<iframe src="http://ghbtns.com/github-btn.html?user=mdo&repo=github-buttons&type=watch&count=true&size=large"
  allowtransparency="true" frameborder="0" scrolling="0" width="170" height="30"></iframe>

Limitations

For the first versions, functionality is limited and some concessions were made:

• Width and height must be specificed for all buttons (which actually adds some control for those with OCD like myself).
• All attributes must be passed through via URL parameters.
• CSS and javascript are all included in the same HTML file to reduce complexity and requests.

Usage with SSL

In order to avoid insecure content warnings when using GitHub Buttons on a page behind an SSL certificate, simply host a copy of the github-btn.html file on your secure directory and substitute your domain in the iframe include:

<iframe src="https://YOURDOMAIN.com/github-btn.html?user=USERNAME&repo=REPONAME&type=BUTTONTYPE"
  allowtransparency="true" frameborder="0" scrolling="0" width="62" height="20"></iframe>

More refinement and functionalty is planned with open-sourcing--any help is always appreciated!

Bug tracker

Have a bug? Please create an issue here on GitHub at https://github.com/mdo/github-buttons/issues.

See also

• ntkme/github-buttons

Twitter account

Keep up to date on announcements and more by following Mark on Twitter, @mdo.

Author

Mark Otto

• http://twitter.com/mdo
• http://github.com/mdo

Copyright and license

Copyright 2014 Mark Otto. Released under Apache 2.0.