Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lepture/github-cards

The unofficial GitHub Cards. Card for your GitHub profile, card for your GitHub repositories.
https://github.com/lepture/github-cards

Last synced: 12 days ago
JSON representation

The unofficial GitHub Cards. Card for your GitHub profile, card for your GitHub repositories.

Awesome Lists containing this project

README

        

# Unofficial GitHub Cards

Card for your GitHub profile, card for your GitHub repositories.

[![Donate lepture](https://img.shields.io/badge/donate-lepture-green.svg)](https://typlog.com/donate?amount=10&reason=lepture%2Fgithub-cards)

![GitHub Cards Preview](https://f.cloud.github.com/assets/290496/1350967/28069848-3716-11e3-8f87-0bef45aff1c4.png)

**New theme available**

![GitHub Cards Medium Theme](https://cloud.githubusercontent.com/assets/290496/5024776/7267e9c8-6b4a-11e4-9513-472b60b955b1.png)

## Usage

The cards are hosted via GitHub Pages.

Visit card generator: http://lab.lepture.com/github-cards/

### widget.js

You can include the `widget.js` script, it will create the embed iframes
for you.

Example of user card:

```html

```

Example of repo card:

```html

```

Data parameters:

- user: GitHub username
- repo: GitHub repository name
- width: Embed width you want, default is 400
- height: Embed height you want, default is 200
- theme: GitHub card theme, default is `default`
- target: If you want to open links in new tab, set it to `blank`
- client_id: Your app client_id, optional
- client_secret: Your app client_secret, optional

You can also define in meta tags:

```html

```

## Limitation

There are some limitations for github cards.

1. GitHub API rate limitation
2. No interaction. You can't actually follow someone

## SSL support

GitHub Cards is available on jsdelivr now. Use widget hosted on jsdelivr:

```html

```

## Contribution

This project is under the BSD License.