62 lines
1.9 KiB
Markdown
62 lines
1.9 KiB
Markdown
# Astro GitHub Stats ✨
|
|
|
|
[](https://www.npmjs.com/package/astro-github-stats)
|
|
[](https://www.npmjs.com/package/astro-github-stats)
|
|
[](https://www.npmjs.com/package/astro-github-stats)
|
|
[](https://github.com/ayoayco/astro-github-stats)
|
|
|
|
Embed GitHub stats on your [Astro](https://astro.build) page ✨
|
|
|
|
Features:
|
|
|
|
1. Embed GitHub Account stats
|
|
1. Embed GitHub Account top languages
|
|
1. Embed GitHub Repositories info with stars
|
|
|
|
# Insatllation
|
|
|
|
```
|
|
npm i astro-github-stats
|
|
```
|
|
|
|
# Usage
|
|
|
|
Then use on your Astro page:
|
|
|
|
```astro
|
|
---
|
|
import GithubStats from 'astro-github-stats';
|
|
---
|
|
|
|
<!-- Add your account stats -->
|
|
<GithubStats username="ayoayco" />
|
|
|
|
<!-- Add your account stats -->
|
|
<GithubStats username="ayoayco" topLanguages={true} />
|
|
|
|
<!-- Add a repo card with info and stars -->
|
|
<GithubStats username="withastro" repo="astro" />
|
|
```
|
|
|
|
# Screenshots
|
|
|
|
Example Account Card:
|
|
|
|
|
|
|
|
Example Account Top Languages:
|
|
|
|
<img width="312" alt="Screen Shot 2022-09-29 at 9 09 05 PM" src="https://user-images.githubusercontent.com/4262489/193121588-9737c861-d08a-4103-9d9b-11bcd0c7c713.png">
|
|
|
|
Example Repo Card:
|
|
|
|
|
|
|
|
# Future plans
|
|
|
|
Initially this is a wrapper for [github-readme-stats](https://github.com/anuraghazra/github-readme-stats) supporting the basic github account stats card. Other features can be supported later, depending on demand:
|
|
|
|
1. themes
|
|
1. account top languages
|
|
|
|
_Please report issues found or suggestions in the [project issues page](https://github.com/ayoayco/astro-github-stats/issues)_
|