Skip to content

Latest commit

 

History

History
69 lines (58 loc) · 2.71 KB

README_zh-tw.md

File metadata and controls

69 lines (58 loc) · 2.71 KB
Raw

Github-profilemd-Generater

English | 日本語 | 繁體中文 | 简体中文

前言

Github-profilemd-Generate 是在 Github Action上運行的工具,
用來統計Github帳戶的資訊並製作成卡片放在自我介紹上。

功能

  • Repositories Composition - 程式庫的語言統計
  • Tags Preference - 標籤的喜好
  • ...
  • ...
  • .etc

工作原理 ?

從 Github GraphQL上獲取資料 → 繪製 .SVG 檔案→ 工具會提交並推出到倉庫的"master" 分支.

使用方法

在使用此工具之前, 確保你已經發現 Github隱藏的秘密.
例如 kwangsing3/kwangsing3

Github Action:

  1. 為了使用 Github GraphQL，用來獲得資料的Token是必須的, 點擊 如何新增金鑰用以製作Profile 以了解如何新增用來獲得資訊的Token.

  2. 新增金鑰(Token)至自我介紹倉庫的秘密(secret)裡，並取名叫做 MY_GITHUB_TOKEN。 (查看詳細教學ADD SECRET TO REPO).

  3. 插入以下的步驟至自己的.yml檔案。

 - uses: kwangsing3/github-profilemd-Generater@release
        env: 
          GITHUB_TOKEN: ${{ secrets.MY_GITHUB_TOKEN }}
        with:
          USERNAME: ${{ github.repository_owner }}
          GITHUB_REPO_NAME: ${{ github.event.repository.name }}

  • 或是複製整個步驟檔 範例檔案 至 ./github/workflows/。

本地執行:

執行指令時指定一些係數, 或是在.vscode 中使用 launch.json 以方便使用.

$npm run prod [arg1] [arg2] [arg3]
  • [arg1]: username
  • [arg2]: reponame
  • [arg3]: MY_GITHUB_TOKEN

參與開發

$git clone https://github.com/kwangsing3/github-profilemd.Generater

其他

   為了保持README.MD美觀, Github-profilemd-Genearater 不會覆寫你的 README.md, 它只負責生產統計卡片以及動態更新至程式庫 預設情況下的位置 (./output/github-profilemd-generater/) , 所以請確保你的 README.MD 使用相對路徑來獲得卡片，而不是使用另外上傳圖片.

*** 請留下星星表示支持，也希望這個工具能夠在某一天幫上你的忙 ***

感激不盡 :)