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: 3 months 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 (about 5 years ago)
• Default Branch: develop
• Last Pushed: 2021-08-01T20:15:06.000Z (almost 3 years ago)
• Last Synced: 2024-01-18T18:28:48.131Z (5 months ago)
• Topics: card, embed, github, markdown, ogp, png, repository, svg
• Language: TypeScript
• Homepage: https://gh-card.dev
• Size: 2.84 MB
• Stars: 1,314
• Watchers: 11
• Forks: 33
• Open Issues: 55
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Lists

• awesome-stars - gh-card
• AwesomeCppGameDev - gh-card
• awesome-stars - gh-card
• awesome-stars - nwtgck/gh-card - :octocat: GitHub Repository Card for Any Web Site (TypeScript)
• awesome-github-repos - nwtgck/gh-card - :octocat: GitHub Repository Card for Any Web Site (TypeScript)
• awesome-stars - gh-card - :octocat: GitHub Repository Card for Any Web Site (TypeScript)
• awesome - nwtgck/gh-card - :octocat: GitHub Repository Card for Any Web Site (TypeScript)
• project-awesome - nwtgck/gh-card - :octocat: GitHub Repository Card for Any Web Site (TypeScript)
• awesome-stars - nwtgck/gh-card - :octocat: GitHub Repository Card for Any Web Site (TypeScript)
• awesome-stars - nwtgck/gh-card - :octocat: GitHub Repository Card for Any Web Site (markdown)
• my-stars - nwtgck/gh-card - :octocat: GitHub Repository Card for Any Web Site (TypeScript)
• my-awesome-stars - 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.