Skip to content

Display a card wtih your Gists on your GitHub README.md. Made with Node.js on Vercel.

License

Notifications You must be signed in to change notification settings

Yizack/gists-readme

Repository files navigation

gists-readme

Vercel build Tests codecov

GitHub Gists Readme (gists-readme)

Display a card with your Gists on your GitHub README.md

Generate your card here: https://gists-readme.yizack.com

Cache

Cache is configured to expire after 4 hours and is implemented on the Vercel Edge Network by using Cache-Control: max-age=0, s-maxage=14400 header for every API response.

Gists List Card

Display a list of your gists

Parameters

Parameter Description Optional Default value
user Your GitHub profile username. No
theme Set the theme of the card. Yes default
n Number of Gists to display. Yes 30
title Set the title of the card. Yes My Gists

Card Example 1

Parameter Value
user yizack
theme dark

Result

gists-readme

[![gists-readme](https://gists-readme.yizack.com/api?user=yizack&theme=dark)](https://gist.github.com/Yizack)

Card Example 2

Parameter Value
user yizack
n 2

Result

gists-readme

[![gists-readme](https://gists-readme.yizack.com/api?user=yizack&n=2)](https://gist.github.com/Yizack)

Card Example 3

Parameter Value
user Cy4Bot
n 20
title Cy4Bot Gists

Result

gists-readme

[![gists-readme](https://gists-readme.yizack.com/api?user=Cy4Bot&n=20&title=Cy4Bot+Gists)](https://gist.github.com/Cy4Bot)

Gists Pin

Parameters

Parameter Description Optional Default value
id Your Gist ID No
owner Shows the owner of the gist, Yes false
theme Sets the theme of the pin. Yes default

Pin Example 1

Parameter Value
id bbfce31e0217a3689c8d961a356cb10d

Result

gists-readme

[![gists-readme](https://gists-readme.yizack.com/api/pin?id=bbfce31e0217a3689c8d961a356cb10d)](https://gist.github.com/Yizack/bbfce31e0217a3689c8d961a356cb10d)

Pin Example 2

Parameter Value
id 07694a749c8fc5f4d996a2bd50237939
owner true
theme dark

Result

gists-readme

[![gists-readme](https://gists-readme.yizack.com/api/pin?id=07694a749c8fc5f4d996a2bd50237939&owner=true&theme=dark)](https://gist.github.com/Yizack/07694a749c8fc5f4d996a2bd50237939)

Inspired by anuraghazra/github-readme-stats.
Hosted on Vercel with Node.js.