Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/nwtgck/gh-card

:octocat: GitHub Repository Card for Any Web Site
https://github.com/nwtgck/gh-card

card embed github markdown ogp png repository svg

Last synced: 5 days ago
JSON representation

:octocat: GitHub Repository Card for Any Web Site

Host: GitHub
URL: https://github.com/nwtgck/gh-card
Owner: nwtgck
License: mit
Created: 2019-06-11T17:37:21.000Z (over 5 years ago)
Default Branch: develop
Last Pushed: 2021-08-01T20:15:06.000Z (over 3 years ago)
Last Synced: 2024-11-28T22:22:41.274Z (14 days ago)
Topics: card, embed, github, markdown, ogp, png, repository, svg
Language: TypeScript
Homepage: https://gh-card.dev
Size: 2.84 MB
Stars: 1,328
Watchers: 10
Forks: 33
Open Issues: 55
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

awesome-github-repos - nwtgck/gh-card - :octocat: GitHub Repository Card for Any Web Site (TypeScript)
AwesomeCppGameDev - gh-card
project-awesome - nwtgck/gh-card - :octocat: GitHub Repository Card for Any Web Site (TypeScript)

README

        # gh-card

[![CircleCI](https://circleci.com/gh/nwtgck/gh-card.svg?style=shield)](https://circleci.com/gh/nwtgck/gh-card)

GitHub Repository Card for Every Web Site: 

## Example SVG card

![Piping Server static repo card](doc_assets/piping-server.svg)  

## Demo

![gh-card](doc_assets/gh-card.gif)

## How it works?

The idea is similar to status badges from Travis CI, CircleCI and etc.

An image URL is like "". The request triggers the backend server to call GitHub API request. The repository information are cached currently by Redis.

## Related projects

* [GitHub Link Card Creator](https://github.com/po3rin/github_link_creator)

* [Unofficial GitHub Cards](https://github.com/lepture/github-cards)

This might be similar to them. The purpose of this project is to provide an image which can be used in every site and the design should be like official GitHub repo card. I hope one day GitHub itself provides this feature officially.