Skip to content

rocktimsaikia/github-card

Folders and files

NameName
Last commit message
Last commit date

Latest commit

6e72ed0 Β· Apr 26, 2021

History

51 Commits
Apr 23, 2021
Apr 26, 2021
Apr 26, 2021
Nov 27, 2020
Apr 22, 2021
Nov 27, 2020
Apr 23, 2021
Nov 27, 2020
Apr 23, 2021
Apr 26, 2021
Apr 23, 2021
Apr 23, 2021

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