gists-readme

Vercel buildTestscodecov

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

ParameterDescriptionOptionalDefault value
userYour GitHub profile username.No
themeSet the theme of the card.Yesdefault
nNumber of Gists to display.Yes30
titleSet the title of the card.YesMy Gists

Card Example 1

ParameterValue
useryizack
themedark

Result

gists-readme

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

Card Example 2

ParameterValue
useryizack
n2

Result

gists-readme

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

Card Example 3

ParameterValue
userCy4Bot
n20
titleCy4Bot 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

ParameterDescriptionOptionalDefault value
idYour Gist IDNo
ownerShows the owner of the gist,Yesfalse
themeSets the theme of the pin.Yesdefault

Pin Example 1

ParameterValue
idbbfce31e0217a3689c8d961a356cb10d

Result

gists-readme

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

Pin Example 2

ParameterValue
id07694a749c8fc5f4d996a2bd50237939
ownertrue
themedark

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.