ghscard
Summary
ghscard is a JavaScript widget to generate interactive GitHub user/repository/organization cards for static web pages (like GitHub pages/Read the Docs).
Demo
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='//cdn.jsdelivr.net/gh/thombashi/ghscard@master/dist/ghscard.min.js'></script>
</body>
</html> |
|---|
The above HTML rendered as follows:
| Output: |
|
|---|
CDN
-
- Version specific
-
https://cdn.jsdelivr.net/npm/ghscard@<version>/dist/ghscard.min.js- e.g. https://cdn.jsdelivr.net/npm/ghscard@0.4.1/dist/ghscard.min.js
For more information
More examples are available at https://ghscard.rtfd.io/en/latest/pages/usage/index.html
Dependencies
CLI Tool Dependencies
Python 3.5+
Tested environment
Tested Web Browsers| Web browser | Version |
|---|---|
Google Chrome |
57.0 or newer |
Mozilla Firefox |
52.0 or newer |
