Skip to content

Latest commit

 

History

History
116 lines (77 loc) · 4.88 KB

README.zh-tw.md

File metadata and controls

116 lines (77 loc) · 4.88 KB
Raw

GitHub Profile Summary Cards

這份專案受到 profile-summary-for-github 啟發

Test and Lint License: MIT release

繁體中文

⭐ 這份 repo 是好玩才寫的,任何貢獻都很歡迎！ ⭐

Markdown 用法

馬上試試!!

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

範例

更多主題

如何使用 (GitHub Actions)

這個 GitHub Action 會產生你的 GitHub 個人統計圖表並且 commit 到你的 repo 裡. 新增 這個Action 之後你也可以自己觸發 action.

⭐ 跟著教學 ( 推薦 ) ⭐

第一步

使用模板 ( 創建一個儲存庫 )

  • github-profile-summary-cards-example

  • Action 已經在這個模板裡設定好了, 你只需要按下 use this template button 來創建你的 profile readme.

  • 用你儲存庫裡的 secret 來更換 action yml 檔案裡的 GITHUB_TOKEN 並且觸發 action 後你就可以使用所有在 profile-summary-card-output 資料夾底下的東西.

新增到現有的儲存庫

  • 新增這個 action 到儲存庫,並且用你儲存庫裡的 secret 來更換 action yml 檔案裡的 GITHUB_TOKEN.

GitHub Actions 使用方法

在 action 完成之後. 你可以看到所有東西都在名稱為 profile-summary-card-output 的資料夾底下.

筆記: 所有卡片可能不會立即更新,因為 github raw file 有做 cache

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/checkout@v4
      - uses: vn7n24fzkq/github-profile-summary-cards@release
        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 }}
          # BRANCH_NAME is optional, default to main, branch name to push cards
          BRANCH_NAME: "main"
          # UTC_OFFSET is optional, default to zero
          UTC_OFFSET: 8

本地執行

  • 要求 node 16, 較低版本可能會出錯。
  • 新增 GITHUB_TOKEN 到 .evn 檔案裡。 ex:GITHUB_TOKEN=abcda69ddf66ae95538c5b1666591b59b4abc73a
  • 修改之後記得要 npm run build
npm run run [username] [UTC offset]

範例

npm run run vn7n24fzkq 8