GitHub Profile Summary Cards

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

繁體中文

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

Markdown Usage

Try it now!!

![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=vue)

default	solarized	monokai
solarized_dark	vue	nord_bright

Example

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

• You need create a Personal access token with correct permissions. Personal token permissions

• Add personal access token to repo secret.

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

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

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

    steps:
      - 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 }}
        with:
          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]

Example

npm run run vn7n24fzkq 8