A JavaScript widget to generate GitHub user/repository/organization cards for static web pages (like GitHub pages).
Project description
ghscard
Summary
A JavaScript widget to generate 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 a HTML file
<!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 will be displayed 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 |
Mozilla Firefox |
52.0 |
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.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a9527a2a85d55ad41fd3ed9fce299fa35276ca99a2ec80d376c61d3b5e8caea7 |
|
MD5 | 80b18d11d8fc999e7b9405315f2e57f2 |
|
BLAKE2b-256 | 3b07747e7fccc31fb8c5124e20b0d404afe6350169452232f7b3fc8d0b9e4fe5 |