Skip to main content

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).

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

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:

Output:
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.4+

Tested environment

Tested Web Browsers

Web browser

Version

Google Chrome

57.0 or newer

Mozilla Firefox

52.0 or newer

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.

Source Distribution

ghscard-0.0.7.tar.gz (200.0 kB view hashes)

Uploaded Source

Built Distribution

ghscard-0.0.7-py2.py3-none-any.whl (17.2 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page