{"id":13714583,"url":"https://github.com/datarootsio/github-stats-card","last_synced_at":"2025-04-11T01:44:36.507Z","repository":{"id":180359892,"uuid":"661988720","full_name":"datarootsio/github-stats-card","owner":"datarootsio","description":"⭐️ a minimal but inclusive github stats badge ⭐️","archived":false,"fork":false,"pushed_at":"2023-08-07T11:37:39.000Z","size":3610,"stargazers_count":13,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-01T15:53:47.785Z","etag":null,"topics":["badge","github","profile","readme","stats"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/datarootsio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-07-04T05:58:22.000Z","updated_at":"2025-01-19T08:54:45.000Z","dependencies_parsed_at":null,"dependency_job_id":"67dfdc1b-4b8a-4daa-a9b3-07291d1c544a","html_url":"https://github.com/datarootsio/github-stats-card","commit_stats":null,"previous_names":["bart6114/github-stats-card"],"tags_count":51,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datarootsio%2Fgithub-stats-card","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datarootsio%2Fgithub-stats-card/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datarootsio%2Fgithub-stats-card/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datarootsio%2Fgithub-stats-card/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/datarootsio","download_url":"https://codeload.github.com/datarootsio/github-stats-card/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248327796,"owners_count":21085257,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["badge","github","profile","readme","stats"],"created_at":"2024-08-03T00:00:32.981Z","updated_at":"2025-04-11T01:44:36.490Z","avatar_url":"https://github.com/datarootsio.png","language":"TypeScript","readme":"# github-stats-card\n⭐️ *a minimal but inclusive github stats badge* ⭐️\n\nThis is a GitHub Action that generated a stats badge that you can use on your GitHub [profile page](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile).\n\nWhy this stats badge generator you say? Because I noticed that people creating repos under organizations and receiving stars did not count towards their stars in most badge generation tools. And that's just a pity. So, in comes `github-stats-card`, a minimal but inclusive GitHub stats badge generator.\n\n## Usage\n\nThe badge generator set up to works as a GitHub action. You can add it to the GH Actions workflow of your profile page as a step. Below an example workflow yaml.\n\n\n```yaml\nname: generate badge\non:\n  workflow_dispatch:\n  push:\n  schedule:\n    - cron: '0 0 * * 0'\n\njobs:\n  update:\n    name: Update stats card\n    runs-on: ubuntu-latest\n    steps:\n      - uses: datarootsio/github-stats-card@v1\n        with:\n          username: bart6114\n          gh_token_stats: ${{ secrets.GH_PAT }}\n          gh_token_commits: ${{ secrets.GITHUB_TOKEN }}\n          badge_path: assets/badge.svg\n          header: \"👋 hi i'm\"\n          about: \"Loves goblins, despises gnomes.\\nEnjoys candlelit custard pudding.\"\n          theme: dark\n          commit_message: Badge generated by the treadmill bunnies.\n```\n\nIf the workflow has succesfully ran, it will create a badge under `assets/badge.svg`. That you can then include in your readme via `![ain't it a beaut](assets/badge.svg)`.\n\n## Themes\n\nThe following themes are available, see [configuration options](#configuration-options) on how to specify theme.\n\nWant to create your own themes? Check out the `themes/` folder, it rather straightforward. PRs are very much welcome! ❤️\n\n`theme: dark` 👇 (default theme)\n\n![](assets/badge-dark.svg)\n\n`theme: cool-lake` 👇\n\n![](assets/badge-cool-lake.svg)\n\n`theme: neko-sleeps` 👇\n\n![](assets/badge-neko-sleeps.svg)\n\n`theme: jimmy-goes-fishing` 👇\n\n![](assets/badge-jimmy-goes-fishing.svg)\n\n`theme: pad-and-paper` 👇\n\n![](assets/badge-pad-and-paper.svg)\n\n`theme: retro-print` 👇\n\n![](assets/badge-retro-print.svg)\n\n`theme: terminal-green` 👇\n\n![](assets/badge-terminal-green.svg)\n\n`theme: tropical-sunset` 👇\n\n![](assets/badge-tropical-sunset.svg)\n\n`theme: a-colibri-hums-while-the-dog-farts` 👇\n\n![](assets/badge-a-colibri-hums-while-the-dog-farts.svg)\n\n`theme: grainy-dreams` 👇\n\n![](assets/badge-grainy-dreams.svg)\n\n`theme: hypnotoad` 👇\n\n![](assets/badge-hypnotoad.svg)\n\n\n## Configuration options\n\n`gh_token_stats`: token used for fetching user stats, typically a [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) (PAT) with access to your personal and organisation repos\n\n`gh_token_commits`: [optional] if you set this to `${{ secrets.GITHUB_TOKEN }}` it will use the github actions bot to commit the svg to the repo (if not set it will use your PAT)\n\n`badge_path`: [optional] path of badge svg (defaults to `assets/badge.svg`)\n\n`username`: your username\n\n`header`: [optional] header to use for badge (defaults to: `👋 hi i'm`)\n\n`about`: about me description to use for badge (use \\n for newlines)\n\n`commit_message`: [optional] commit message to use (defaults to `Update badge`)\n\n`commit`: [optional] whether to commit badge to repo (defaults to `true`)\n\n`exclude_repos`: [optional] comma separated list of repos to exclude from stats, will do regex based matching (e.g. 'datarootsio' will match all repos in dataroots, 'datarootsio/databooks' will only match a single repo)\n\n`exclude_repos_override`: [optional] comma separated list of repos to override from exclusion list (e.g. 'datarootsio' in exclude_repos and 'datarootsio/databooks' in exclude_repos_override will ONLY include databooks in stats)\n\n`theme`: [optional] see [themes](#themes) for options\n\n## FAQ\n\n- *Which repositories count towards my stargazers count?*\n\n    Check out the logs of your action run. It will log which repositories are included after the exclude and override filters have been applied.\n\n- *How do I refresh the badge?*\n\n    You probably want to look into the `schedule` [event trigger](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule). It allows you to use a cron-based schedule that allows you to for example refresh your badge daily.\n\n","funding_links":[],"categories":["Community Resources"],"sub_categories":["Utility"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatarootsio%2Fgithub-stats-card","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdatarootsio%2Fgithub-stats-card","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatarootsio%2Fgithub-stats-card/lists"}