Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/utensil/jquery-github-widget
A widget to show a Github user's basic info and repositories, written as a jQuery plugin.
https://github.com/utensil/jquery-github-widget
Last synced: 3 months ago
JSON representation
A widget to show a Github user's basic info and repositories, written as a jQuery plugin.
- Host: GitHub
- URL: https://github.com/utensil/jquery-github-widget
- Owner: utensil
- License: mit
- Created: 2012-03-15T15:47:00.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2013-10-11T14:35:26.000Z (about 11 years ago)
- Last Synced: 2024-06-28T07:32:47.890Z (5 months ago)
- Language: CSS
- Homepage: http://utensil.github.com/jquery-github-widget/demo/index.html
- Size: 150 KB
- Stars: 8
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
jQuery Github Widgets
=======================
A widget to show a Github user's basic info and repositories, written as a jQuery plugin.
Demo
----------
See it live [here](http://utensil.github.com/jquery-github-widget/demo/index.html).
Usage
------
Make sure you're using the HTML5 doctype at the top of your html:
```html
```
From within the <head>:
```html
```
Where you wish to show the widget:
```html
```
Initialize the widget like other jQuery plugins:
```js
$('#github-widget-holder').github_widget({
user : 'jquery', // (required) your github username
});
```
Compatibility
-----------------
Aimed at and tested under the following browsers:
* Chrome 9+
* Firefox 3.6+
* IE 7+
* Safari 5.0+
* Opera
Rationale
----------------------
There are a few options out there to present a Github widget, just search Github or Google with the combination of 'github', 'view' and 'widget', in case new alternatives surface.
Among them I tried [Gitview](https://github.com/bouchon/Gitview), it has a pretty demo, looks great and feels like what I want, but:
* it uses javascript to do CSS thing, which I found hard to theme
* it uses table to do layout, which isn't to my taste
* it depends on Dojo, and its dynamical loading doesn't always work
* it even depends on the domain of http://logicalcognition.com
So I decided to write one of my own, with the following ideas:
* To present a Github widget is a simple task, it's meant to be done simply, and should be easy to fork and play with.
* Its data should be live, retrieved by JSONP calls to Github public API, and no other backends would be required, so it would be easy to deploy to static hosts such as Github Pages.
* Its UI should be just simple js code to form a DOM and to use customizable CSS to style it, so others can change the CSS to theme it or even adjust the DOM for their taste.
* It shoulde be as HTML5&CSS3 as possible.
* It's OK to depend on a widely used js library such as jQuery, or to depend on [github-api](https://github.com/fitzgen/github-api), but no more.
* It should be written in CoffeeScript and SCSS to avoid the ugly part of js and CSS.
* It would be great to use [jQuery Mobile](http://jquerymobile.com/demos/) to make it more than a widget, like [Codeshelver](https://www.codeshelver.com/), but use HTML5 local storage, so it can be deploy to static hosts.
Development Status
-------------------
Consider it as 0.1.0, in the context of [SemVer](http://semver.org/).
Test Status
--------------
It's mostly UI, so I haven't put it under any tests yet.
Future Work
--------------
Unlimited.
Next iteration might be:
* code cleanup
* docs(possiblly using [doc.js](https://github.com/b-studios/doc.js)? )
* participation graph
* pagination
* more options
Acknowledgments
-----------------
* [Gitview](https://github.com/bouchon/Gitview) for the inspiration
* [Github user profile page itself](https://github.com/utensil) for its DOM, CSS and images.
Licence
--------
MIT Licence, see LICENCE.
Copyright (c) 2011-2012 Utensil Song (https://github.com/utensil)
[](https://bitdeli.com/free "Bitdeli Badge")