A JavaScript widget to generate interactive GitHub user/repository/organization cards for static web pages (like GitHub pages).
Project description
ghscard
Summary
A JavaScript widget to generate interactive GitHub user/repository/organization cards for static web pages (like GitHub pages).
Demo
- Popular Repositories on GitHub - https://thombashi.github.io/
Quick Start
CLI Tool Installation
Install ghscard CLI tool from PyPI via pip (Python package manager) command.
pip install ghscard
Generate card data files
Execute ghscard gen command to generate a GitHub user/organization/repository card data file.
$ ghscard gen thombashi -o data [INFO] ghscard gen: written user data to 'data/thombashi.json'
$ ghscard gen Microsoft/TypeScript -o data [INFO] ghscard gen: written repository data to 'data/Microsoft_TypeScript.json'
Add widget to an HTML file
- Example:
<!doctype html> <html> <body> <table border=
"0"> <tr> <td> <div class='ghscard'src='data/thombashi.json'></div> </td> <td> <div class="ghscard"src="data/Microsoft_TypeScript.json"></div> </td> </tr> </table> <script src='//rawgit.com/thombashi/ghscard/master/dist/ghscard.min.js'></script> </body> </html>
This HTML rendered as follows:
For more information
More examples are available at http://ghscard.rtfd.io/en/latest/pages/usage/index.html
Dependencies
CLI Tool Dependencies
Python 2.7+ or 3.3+
Tested environment
Web browser |
Version |
---|---|
Google Chrome |
57.0 or newer |
Mozilla Firefox |
52.0 or newer |
Documentation
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ghscard-0.0.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 588d7c3c335d8e1bf1bcef2b1a4d5d8887e859d74ad6dbbc099ed7bdf4e6c1ec |
|
MD5 | a81c422c8bf84ac72fc2453bb2b5ecb2 |
|
BLAKE2b-256 | 2794f8c147d1c7f8ce81a9c55e98dd6232292fc40b52dae088371c0155e9fa8f |