Skip to content

JQueryCollection/jquery-github

Repository files navigation

jQuery Github Build Status

Github Repo Demonstration

Usage

Create an attribute called data-repo:

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

Include jQuery:

<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/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
});

iconStars

Type: Boolean Default: true

Display the number of stars in a repository.

iconForks

Type: Boolean Default: true

Display the number of forks in a repository.

iconIssues

Type: Boolean Default: false

Display the number of issues in a repository.

Showcase

Have you used this plugin in your project?

Let me know! Send a tweet or pull request and I'll add it here :)

Forks

Prefer a non-jquery version with pure JavaScript?

No problem, @ricardobeat already did one. Check his fork!

Contributing

Check CONTRIBUTING.md.

History

Check HISTORY.md.

Credits

Built on top of jQuery Boilerplate

License

MIT License

About

A jQuery plugin to display your Github Repositories

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 62.8%
  • CSS 25.1%
  • HTML 12.1%