https://github.com/thombashi/ghscard
A JavaScript widget to generate interactive GitHub user/repository/organization cards for static web pages (like GitHub pages).
https://github.com/thombashi/ghscard
github github-card javascript typescript widget
Last synced: 11 months ago
JSON representation
A JavaScript widget to generate interactive GitHub user/repository/organization cards for static web pages (like GitHub pages).
- Host: GitHub
- URL: https://github.com/thombashi/ghscard
- Owner: thombashi
- License: mit
- Created: 2017-03-20T15:01:32.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-07-20T07:48:02.000Z (over 2 years ago)
- Last Synced: 2025-04-27T09:02:39.065Z (12 months ago)
- Topics: github, github-card, javascript, typescript, widget
- Language: JavaScript
- Homepage: https://ghscard.rtfd.io/
- Size: 2.12 MB
- Stars: 10
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
.. contents:: **ghscard**
:backlinks: top
:depth: 2
Summary
=========
`ghscard `__ is a JavaScript widget to generate interactive GitHub user/repository/organization cards for static web pages (like GitHub pages/Read the Docs).
.. image:: https://badge.fury.io/py/ghscard.svg
:target: https://badge.fury.io/py/ghscard
:alt: PyPI package version
.. image:: https://img.shields.io/pypi/pyversions/ghscard.svg
:target: https://pypi.org/project/ghscard
:alt: Supported Python versions
.. image:: https://img.shields.io/npm/v/ghscard
:target: https://www.npmjs.com/package/ghscard
:alt: npm package version
.. image:: https://img.shields.io/travis/thombashi/ghscard/master.svg?label=Linux%20CI
:target: https://travis-ci.org/thombashi/ghscard
:alt: Linux CI status
.. image:: https://img.shields.io/github/stars/thombashi/ghscard.svg?style=social&label=Star
:target: https://github.com/thombashi/ghscard
:alt: GitHub stars
Demo
======
- `Popular Repositories on GitHub `__
- https://thombashi.github.io/
CLI Tool Installation
====================================
Install ``ghscard`` CLI tool from `PyPI /pypi.python.org/pypi>`__ via
`pip /pip.pypa.io/en/stable/installing/>`__ (Python package manager) command.
::
pip install ghscard
Dependencies
====================================
CLI Tool Dependencies
----------------------
- Python 3.5+
- `Python package dependencies (automatically installed) `__
Quick Start
================
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:
.. code-block:: html
The above HTML rendered as follows:
:Output:
.. image:: ss/quickstart.png
:width: 600px
:alt: Click to navigate to the HTML page
:target: //thombashi.github.io/ghscard/quickstart/
CDN
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- Version specific
- ``https://cdn.jsdelivr.net/npm/ghscard@/dist/ghscard.min.js``
- e.g. https://cdn.jsdelivr.net/npm/ghscard@0.4.1/dist/ghscard.min.js
- Latest version
- https://cdn.jsdelivr.net/gh/thombashi/ghscard@master/dist/ghscard.min.js
For more information
----------------------
More examples are available at
https://ghscard.rtfd.io/en/latest/pages/usage/index.html
Tested environment
=======================
.. table:: Tested Web Browsers
======================= ===========================
Web browser Version
======================= ===========================
``Google Chrome`` ``57.0`` or newer
``Mozilla Firefox`` ``52.0`` or newer
======================= ===========================
Documentation
---------------
https://ghscard.rtfd.io/
Sponsors
====================================
.. image:: https://avatars0.githubusercontent.com/u/44389260?s=48&u=6da7176e51ae2654bcfd22564772ef8a3bb22318&v=4
:target: https://github.com/chasbecker
:alt: Charles Becker (chasbecker)
`Become a sponsor `__