jQuery Plugin To Display Github Repo Information - Github

jQuery Plugin To Display Github Repo Information - Github
File Size: 209 KB
Views Total:
Last Update:
Publish Date:
Official Website: Go to website
License: MIT
   

Github is a Github widget for jQuery and Zepto that displays any Github Repository information (description, stars, forks, and issues) on the web page.

See also:

How to use it:

1. Load the required jQuery Github plugin's CSS to style the Github widget.

<link rel="stylesheet" href="assets/base.css">

2. Create an empty DIV element for the widget and use data-repo attribute to specify the path of Github Repository you'd like to display in the element.

<div data-repo="iqq800/Input-Notes" class="github-box-wrap"></div>

3. Load the jQuery javascript library and jQuery Github plugin's javascript at the end of the page.

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

4. Initialize the plugin with options.

<script>
$("[data-repo]").github({
iconStars:  true, // Display the number of stars in a repository.
iconForks:  true, // Display the number of forks in a repository.
iconIssues: false // Display the number of issues in a repository.
});
</script>

This awesome jQuery plugin is developed by zenorocha. For more Advanced Usages, please check the demo page or visit the official website.