GitHub Badge

What

Want to show off your projects on github to world?
Then a sexy badge on your blog would be awesome. Like the one above, but
for your github projects and forks. So, its awesomer.

Installation

Sample HTML to paste into your blog sidebar:

<div id="github-badge"></div>
<script type="text/javascript" charset="utf-8">
  GITHUB_USERNAME="drnic";
</script>
<script src="https://drnic.github.com/github-badges/dist/github-badge-launcher.js" type="text/javascript"></script>

A full outline of available options:

<div id="github-badge"></div>
<script type="text/javascript" charset="utf-8">
  GITHUB_USERNAME="drnic";
  GITHUB_LIST_LENGTH=10;
  GITHUB_HEAD="div"; // e.g. change to "h2" for wordpress sidebars
  GITHUB_THEME="white"; // try 'black'
  GITHUB_TITLE = "My projects"
  GITHUB_SHOW_ALL = "Show all"
</script>
<script src="https://drnic.github.com/github-badges/dist/github-badge-launcher.js" type="text/javascript"></script>

Only GITHUB_USERNAME is a required pre-set variable. The others above show the defaults, and can be changed by being specified.

Black background? If your site has a black background the badge will automatically attempt to use the black_badge.css theme. If it doesn’t trigger for your site add the GITHUB_THEME='black' code to the configuration above.

Existing installations/demonstrations

• Dr Nic Williams
• Chris Wanstrath (creator of GitHub)
• James Rosen
• Mike Mondragon
• ihower
• Jon Maddox
• Carlos Brando

Forum

https://groups.google.com/group/github

How to submit patches

Read the 8 steps for fixing other people’s code and for section 8b: Submit patch to Google Groups, use the Google Group above.

You can fetch the source from:

• github: https://github.com/drnic/github-badges/tree/master

git clone git://github.com/drnic/github-badges.git

License

This code is free to use under the terms of the MIT license.

Contact

Comments are welcome. Send an email to Dr Nic Williams via the github forum

Dr Nic Williams, 27th January 2009
Theme extended from Paul Battley