astro-github-stats/README.md
2022-09-29 21:12:11 +02:00

1.9 KiB

Astro GitHub Stats

npm npm npm github

Embed GitHub stats on your Astro page

Features:

  1. Embed GitHub Account stats
  2. Embed GitHub Account top languages
  3. Embed GitHub Repositories info with stars

Insatllation

npm i astro-github-stats

Usage

Then use on your Astro page:

---
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:

screenshot

Example Account Top Languages:

Screen Shot 2022-09-29 at 9 09 05 PM

Example Repo Card:

Screen Shot 2022-09-27 at 3 51 15 PM

Future plans

Initially this is a wrapper for github-readme-stats supporting the basic github account stats card. Other features can be supported later, depending on demand:

  1. themes
  2. account top languages

Please report issues found or suggestions in the project issues page