Awesome Open Source
Awesome Open Source

GitHub Profile Summary Cards

This repo is inspired by profile-summary-for-github

Test and Lint License: MIT release Conventional Commits


⭐️ This repo is just for fun, feel free to contribute! ⭐️

Markdown Usage

Try it now!!


default solarized monokai
solarized_dark vue nord_bright


More themes

How to use (GitHub Actions)

This action generate your github profile summary cards and make a commit to your repo. You can also trigger action by yourself after add this action.

⭐️ Follow tutorial ( Recommendation ) ⭐️

First step

Use template ( create a repository )

  • github-profile-summary-cards-example

  • Action already setup in this template, you just need click use this template button to create your profile readme.

  • After replace GITHUB_TOKEN with your repo secret and trigger action you can use everything in profile-summary-card-output folder.

Add to exist repository

  • Add this action to repo and replace GITHUB_TOKEN in action yml file with your repo secret.

GitHub Actions usage

After the action finished. You can see all of summary cards are in folder which named profile-summary-card-output.

Note: Some summary cards might not be updated in time, because github raw file has cache time.

name: GitHub-Profile-Summary-Cards

  schedule: # execute every 24 hours
    - cron: "* */24 * * *"

    runs-on: ubuntu-latest
    name: generate-github-profile-summary-cards

      - uses: actions/[email protected]
      - uses: vn7n24fzkq/[email protected]
        env: # default use ${{ secrets.SUMMARY_GITHUB_TOKEN }}, you should replace with your personal access token
          GITHUB_TOKEN: ${{ secrets.SUMMARY_GITHUB_TOKEN }}
          USERNAME: ${{ github.repository_owner }}
          # UTC_OFFSET is optional, default to zero
          UTC_OFFSET: 8

Local Run

  • Require node 16, lower versions should get some problems.
  • Add personal access token to .env file. ex: GITHUB_TOKEN=abcda69ddf66ae95538c5b1666591b59b4abc73a
  • Remember npm run build after modifying any code
npm run run [username] [UTC offset]


npm run run vn7n24fzkq 8

Alternative Project Comparisons
Related Awesome Lists
Top Programming Languages
Top Projects

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Typescript (255,004
Actions (55,483
Github (43,892
Token (29,698
Card (18,807
Readme (8,057
Github Actions (4,890
Profile Readme (729
Github Profile Readme (248
Summary Cards (3