ayo/astro-github-stats
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
74 commits 1 branch 22 tags 614 KiB
JavaScript 57%
Astro 37.2%
TypeScript 5.8%
Find a file
Ayo Ayco c6bf9b5d36 chore: fix typo
2025-02-09 14:57:05 +01:00
.husky chore: add husky 2024-12-25 21:37:22 +01:00
.vscode chore: set up eslint 2024-12-26 01:08:14 +01:00
assets update readme 2022-09-24 20:09:58 +02:00
demo feat: use astro's Image component 2025-01-08 14:36:23 +01:00
src feat: use astro's Image component 2025-01-08 14:36:23 +01:00
.build.yml chore: add auto mirror to github build script 2025-02-09 14:52:51 +01:00
.editorconfig Initial commit 2022-09-24 16:16:24 +02:00
.gitignore chore(deps): update astro 2024-09-13 22:03:57 +02:00
.prettierignore chore: set up prettier 2024-12-26 01:00:32 +01:00
eslint.config.mjs chore: set up eslint 2024-12-26 01:08:14 +01:00
index.ts chore: format code 2024-12-26 01:08:20 +01:00
LICENSE Create LICENSE 2023-03-10 09:37:23 +01:00
package.json 0.8.0 2025-01-08 14:36:35 +01:00
pnpm-lock.yaml feat: use astro's Image component 2025-01-08 14:36:23 +01:00
prettier.config.mjs chore: set up prettier 2024-12-26 01:00:32 +01:00
README.md chore: fix typo 2025-02-09 14:57:05 +01:00
tsconfig.json Initial commit 2022-09-24 16:16:24 +02:00

README.md

Note

Project moved to SourceHut

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