Check out the demonstration or documentation for more information.
You can download the zip file and manually extract the files into your project or use either bower, npm or git.
# Using bower
bower install --save github-jquery-widgets
# Using node
npm install --save github-jquery-widgets
Dependencies
- jQuery > 1.9
- jQuery UI Widget Factory
- Handlebars runtime
- RadicJS custom build
Optional dependencies
- spin.js
- jquery.slimscroll.js
Written with, by or in
- Javascript
- SCSS
- Grunt
- Bootstrap 3
The package ships with seperate files allowing various ways to handle dependencies and to include/exclude widgets. tip: use grunt-usemin or something likewise to concat and minify your js/css.
<link href="path/to/dist/github-widgets.css" type="text/css" rel="stylesheet">
<link href="path/to/dist/github-profile.css" type="text/css" rel="stylesheet">
<link href="path/to/dist/github-events.css" type="text/css" rel="stylesheet">
<script src="jquery.min.js"></script>
<script src="path/to/dist/dep/packed/radic.githubwidgets.packed.min.js"></script> <!-- includes: spin.js, widget.js, handlebars.runtime.min.js -->
<script src="path/to/dist/github-widget.js"></script>
<script src="path/to/dist/github-profile.js"></script>
<script src="path/to/dist/github-events.js"></script>
As an alternative, instead of using the packed radic.githubwidgets.js, you can use the non-packed version. You will have to include spin.js
, widget.js
and handlebars.runtime.js
yourself. An example:
<link href="path/to/dist/github-widgets.css" type="text/css" rel="stylesheet">
<link href="path/to/dist/github-profile.css" type="text/css" rel="stylesheet">
<link href="path/to/dist/github-events.css" type="text/css" rel="stylesheet">
<script src="jquery.min.js"></script>
<script src="jquery-ui.min.js"></script> <!-- provides widget.js (jQuery UI Widget Factory) -->
<script src="path/to/dist/dep/spin.js"></script>
<script src="path/to/dist/dep/handlebars.runtime.min.js"></script>
<script src="path/to/dist/dep/radic.githubwidgets.min.js"></script>
<script src="path/to/dist/github-widget.js"></script>
<script src="path/to/dist/github-profile.js"></script>
<script src="path/to/dist/github-events.js"></script>
$(function(){
$('selector').githubProfile({
username: 'robinradic'
});
});
More information can be found in the API documentation
By downloading the source, you can create a customized build. You can alter the HTML templates and SCSS.
git clone https://github.com/robinradic/github-jquery-widgets # or fork->clone a version.
cd github-jquery-widgets
./scripts/bootstrap.sh # This will update-init the radicjs submodule and copy the pre-commit hook that updates the submodule before commiting
npm install
bower install
More information soon
Copyright 2014 Robin Radic