Skip to content

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

License

Notifications You must be signed in to change notification settings

thombashi/ghscard

Repository files navigation

ghscard is a JavaScript widget to generate interactive GitHub user/repository/organization cards for static web pages (like GitHub pages/Read the Docs).

PyPI package version Supported Python versions npm package version Linux CI status GitHub stars

Install ghscard CLI tool from PyPI via pip (Python package manager) command.

pip install ghscard

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'
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:Click to navigate to the HTML page

CDN

More examples are available at https://ghscard.rtfd.io/en/latest/pages/usage/index.html

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

https://ghscard.rtfd.io/

Charles Becker (chasbecker)

Become a sponsor