Skip to main content

A JavaScript widget to generate GitHub user/repository/organization cards for static web pages (like GitHub pages).

Project description

ghscard

https://img.shields.io/travis/thombashi/ghscard/master.svg?label=Linux https://img.shields.io/github/stars/thombashi/ghstaticcard.svg?style=social&label=Star

Summary

A JavaScript widget to generate GitHub user/repository/organization cards for static web pages (like GitHub pages).

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:

Click to navigate to the HTML page

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

Tested Web Browsers
Web browser Version
Google Chrome 57.0
Mozilla Firefox 52.0

Documentation

http://ghscard.rtfd.io/

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for ghscard, version 0.0.2
Filename, size File type Python version Upload date Hashes
Filename, size ghscard-0.0.2-py2.py3-none-any.whl (18.9 kB) File type Wheel Python version 2.7 Upload date Hashes View
Filename, size ghscard-0.0.2.tar.gz (200.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page