ayoayco / astro-github-stats

Embed GitHub stats on your Astro page ✨

Home Page:https://ayco.io/showcase/astro-github-stats/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Astro GitHub Stats ✨

npm npm npm github

Embed GitHub stats on your Astro page ✨

Features:

  1. Embed GitHub Account stats (with or without icons)
  2. Embed GitHub Account top languages
  3. Embed GitHub Repositories info with stars

Installation

npm i astro-github-stats

Usage

Then use on your Astro page:

---
import GithubStats from 'astro-github-stats';
---

<!-- show your account stats -->
<GithubStats username="ayoayco" />

<!-- show your account stats w/ icons -->
<GithubStats username="ayoayco" showIcons={true} />

<!-- show your account top languages -->
<GithubStats username="ayoayco" topLanguages={true} />

<!-- show a repo card with info and stars -->
<GithubStats username="withastro" repo="astro" />

Screenshots

Example Account Card:

screenshot

Example Account Card with Icons:

Screen Shot 2022-09-30 at 10 59 39 PM

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

About

Embed GitHub stats on your Astro page ✨

https://ayco.io/showcase/astro-github-stats/

License:BSD 2-Clause "Simplified" License


Languages

Language:JavaScript 52.9%Language:Astro 40.3%Language:TypeScript 6.8%