- ×
Your GitHub open-source contributions on your website or portfolio.
Filed under user interfaceShow AllGithub.js
Github.js is a JavaScript plugin over GitHub APIs v3. It gives an easy way to feature your GitHub open-source contributions on your website or portfolio.
Demo
Click here for live examples.
#Dependency
The plugin has hard dependency on underscore.js(~v1.6.0). You can download it from here.
Installation
Add github.js and github.css to your project. Download v0.1.3.
<link rel='stylesheet' href='github.css'/> // Add underscore.js <script type="text/javascript" src="underscore-min.js"></script> <script type="text/javascript" src='github.js'></script>
Github.js is available via bower and npm.
$ bower install --save githubjs $ npm install --save githubjs
Usage
User Profile
Github.userProfile({ username: "jashkenas", selector: ".user-1" });
User Activity
Github.userActivity({ username: "torvalds", selector: ".user-2" });
Repository Profile
Github.repoProfile({ username: 'atom', reponame: 'atom', selector: '.repo-1' });
Repository Activity
Github.repoActivity({ username: 'joyent', reponame: 'node', selector: '.repo-2' });
Organization Profile
Github.orgProfile({ orgname: 'facebook', selector: '.org-1' });
Organization Activity
Github.orgActivity({ orgname: 'google', selector: '.org-2' });
Documentation
Contribute
To start contributing to Github.js, clone the repository and start playing.
$ git clone git@github.com:akshaykumar6/github-js.git $ cd github-js
If you're not familiar with Git, visit the Git homepage to download Git for your platform.
Got a bug or a feature request? Please open a new issue.
License
github-js © 2015, Akshay Sharma Released under the MIT License.
Authored and maintained by Akshay Sharma.