Skip to content

rocktimsaikia/github-card

Repository files navigation

github-card 🌈

Beautiful embeddable github profile card for your portfolio.
Here is a live codepen Demo

CI npm version

Highlights

  • Tiny and Zero dependencies (~4kb)
  • Simple and easy to use
  • Minimal and neat design
  • Dark theme available

Installation

Available on npm as @rocktimsaikia/github-card.

npm install @rocktimsaikia/github-card

or with yarn

yarn add @rocktimsaikia/github-card

Usage

Since this an ESM web component, you can use it both as a script or through installation.

import '@rocktimsaikia/github-card'

<github-card data-user="rocktimsaikia"></github-card>

Or use it as a script in a html file :

<script type="module" src="https://unpkg.com/@rocktimsaikia/github-card@latest?module"></script>

Theme

You can enable the optional dark theme by setting the data-theme attribute to dark

<github-card data-user="rocktimsaikia" data-theme="dark"></github-card>

License

2021 © MIT Rocktim Saikia