Awesome

jQuery Github

A jQuery plugin to display your Github Repositories.

Browser Support

We do care about it.


IE 8+ ✔	Latest ✔	Latest ✔	Latest ✔	Latest ✔

Getting started

Three quick start options are available:

Download latest release
Clone the repo: git@github.com:zenorocha/jquery-github.git
Install with Bower: bower install jquery-github

Setup

Use Bower to fetch all dependencies:

$ bower install

Now you're ready to go!

Usage

Create an attribute called data-repo:

<div data-repo="jquery-boilerplate/jquery-boilerplate"></div>

Include jQuery:

<script src="http://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>

Include plugin's CSS and JS:

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

Call the plugin:

$("[data-repo]").github();

And that's it \o/

Check full example's source code.

Options

Here's a list of available settings.

$("[data-repo]").github({
	iconStars:  true,
	iconForks:  true,
	iconIssues: false
});

Attribute	Type	Default	Description
`iconStars`	Boolean	`true`	Displays the number of stars in a repository.
`iconForks`	Boolean	`true`	Displays the number of forks in a repository.
`iconIssues`	Boolean	`false`	Displays the number of issues in a repository.

Structure

The basic structure of the project is given in the following way:

.
|-- assets/
|-- demo/
|   |-- index.html
|   |-- index-zepto.html
|-- dist/
|   |-- jquery.boilerplate.js
|   |-- jquery.boilerplate.min.js
|-- src/
|   |-- jquery.boilerplate.coffee
|   |-- jquery.boilerplate.js
|-- .editorconfig
|-- .gitignore
|-- .jshintrc
|-- .travis.yml
|-- github.jquery.json
|-- Gruntfile.js
`-- package.json