Fork me on GitHub

Ever wanted to throw up your Github repos on a site? But want a something that will "just work"? Well this is what you're looking for. A jQuery powered, lightweight Github widget that displays your user information and most recent repos for the world to see.

Using the GitHub widget is super simple, you just need to include the script after the core jQuery library and then set it up in the following way within the <head> of your page and tell it which element on the page you want the widget to appended to.

Usage is super simple, just see the example below:

<link rel="stylesheet" href="github.css">
<script src="jquery.min.js"></script>
<script src="jquery.github.min.js"></script>

<script type="text/javascript">
	$(document).ready(function(){
		$("#some-element").github({
			user: "joepettersson"
		});
	});
</script>

There are lots more options for configuring the widget, all of them are laid out below in a more full usage example:

<link rel="stylesheet" href="github.css">
<script src="jquery.min.js"></script>
<script src="jquery.github.min.js"></script>

<script type="text/javascript">
	$(document).ready(function(){
		$("#some-element").github({
			user: "joepettersson",
			show_extended_info: true,
			show_follows: true,
			width: "400px",
			show_repos: 10,
			oldest_first: false
		});
	});
</script>

These options are explained in more detail at the Github repo where there is also an FAQ about the widget's usage.

Download Simple demo View on Github
© Github, it's names and logos are property of Github Inc.