https://github.com/rocktimsaikia/github-card
Github profile web component that actually looks good
https://github.com/rocktimsaikia/github-card
github-card github-profile-card profile-card web-components widget
Last synced: 5 months ago
JSON representation
Github profile web component that actually looks good
- Host: GitHub
- URL: https://github.com/rocktimsaikia/github-card
- Owner: rocktimsaikia
- License: mit
- Created: 2020-04-12T13:36:35.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-26T02:53:05.000Z (about 4 years ago)
- Last Synced: 2024-11-26T21:55:08.111Z (5 months ago)
- Topics: github-card, github-profile-card, profile-card, web-components, widget
- Language: JavaScript
- Homepage:
- Size: 550 KB
- Stars: 75
- Watchers: 5
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
github-card 🌈
Beautiful embeddable github profile card for your portfolio.
Here is a live codepen Demo
## Highlights
- Tiny and Zero dependencies (`~4kb`)
- Simple and easy to use
- Minimal and neat design
- Dark theme available
## Installation
Available on [npm](https://www.npmjs.com/) as [**@rocktimsaikia/github-card**](https://www.npmjs.com/package/@rocktimsaikia/github-card).
```sh
npm install @rocktimsaikia/github-card
```
or with `yarn`
```sh
yarn add @rocktimsaikia/github-card
```
## Usage
Since this an [ESM](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) web component, you can use it both as a script or through installation.
```js
import '@rocktimsaikia/github-card'
```
Or use it as a script in a `html` file :
```html
```
## Theme
You can enable the optional dark theme by setting the `data-theme` attribute to `dark`
```html
```
## License
2021 © MIT [Rocktim Saikia](https://rocktimcodes.site)