+ A tool to generate your github summary card for profile README. Inspired by profile-summary-for-github +
++ :star: This repo is just for fun, feel free to contribute! :star: +
+ +A tool to generate your github summary card for profile README. Inspired by profile-summary-for-github
From a362464f8fe4344f031a88842e785526b68a6410 Mon Sep 17 00:00:00 2001 From: AIhaisi <144531821+AIhaisi@users.noreply.github.com> Date: Sun, 6 Apr 2025 09:20:55 +0800 Subject: [PATCH 04/14] Update README_zh.md --- docs/README_zh.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README_zh.md b/docs/README_zh.md index cfa4a046c..0b34e335b 100644 --- a/docs/README_zh.md +++ b/docs/README_zh.md @@ -2,7 +2,7 @@A tool to generate your github summary card for profile README. Inspired by profile-summary-for-github
From 489e417245f59f68be9d7ec30c8aef01991d9fa7 Mon Sep 17 00:00:00 2001 From: AIhaisi <144531821+AIhaisi@users.noreply.github.com> Date: Sun, 6 Apr 2025 09:21:55 +0800 Subject: [PATCH 05/14] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2aab527a0..4fc000aa1 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@A tool to generate your github summary card for profile README. Inspired by profile-summary-for-github
From 82f2e4317bb32c7d9833b88428bc57d6b3d84345 Mon Sep 17 00:00:00 2001 From: AIhaisi <144531821+AIhaisi@users.noreply.github.com> Date: Sun, 6 Apr 2025 09:22:21 +0800 Subject: [PATCH 06/14] Update README_zh.md --- docs/README_zh.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README_zh.md b/docs/README_zh.md index 0b34e335b..09d75154d 100644 --- a/docs/README_zh.md +++ b/docs/README_zh.md @@ -2,7 +2,7 @@A tool to generate your github summary card for profile README. Inspired by profile-summary-for-github
From fa1e4b3c506f7ed30a9dcf6b615b025f09b4ab07 Mon Sep 17 00:00:00 2001 From: AIhaisi <144531821+AIhaisi@users.noreply.github.com> Date: Sun, 6 Apr 2025 09:24:39 +0800 Subject: [PATCH 07/14] Update README_zh.md --- docs/README_zh.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README_zh.md b/docs/README_zh.md index 09d75154d..ca90f0a97 100644 --- a/docs/README_zh.md +++ b/docs/README_zh.md @@ -2,7 +2,7 @@A tool to generate your github summary card for profile README. Inspired by profile-summary-for-github
From 412aa45758a20647bb8b3d08591a276e50bf31f8 Mon Sep 17 00:00:00 2001 From: AIhaisi <144531821+AIhaisi@users.noreply.github.com> Date: Sun, 6 Apr 2025 09:25:03 +0800 Subject: [PATCH 08/14] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4fc000aa1..011629a96 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@A tool to generate your github summary card for profile README. Inspired by profile-summary-for-github
From a8751a205f286cac0113b16cbccf0afff3b2ccf1 Mon Sep 17 00:00:00 2001 From: AIhaisi <144531821+AIhaisi@users.noreply.github.com> Date: Sun, 6 Apr 2025 10:09:16 +0800 Subject: [PATCH 09/14] Update README_zh.md --- docs/README_zh.md | 89 +++++++++++++++++++++++------------------------ 1 file changed, 44 insertions(+), 45 deletions(-) diff --git a/docs/README_zh.md b/docs/README_zh.md index ca90f0a97..7fa999cc6 100644 --- a/docs/README_zh.md +++ b/docs/README_zh.md @@ -4,10 +4,10 @@ [English](/README.md) | [简体中文](/docs/README_zh.md) | [繁體中文](/docs/README.zh-tw.md)- A tool to generate your github summary card for profile README. Inspired by profile-summary-for-github + 一个用来生成github个人简介摘要的工具. 受到 profile-summary-for-github的启发
- :star: This repo is just for fun, feel free to contribute! :star: + :star: 欢迎大家随时贡献 :star:
@@ -23,7 +23,7 @@
一个用来生成github个人简介摘要的工具. 受到 profile-summary-for-github的启发
A tool to generate your github summary card for profile README. Inspired by profile-summary-for-github
@@ -35,7 +35,7 @@
-## Themes
+## Themes | 主题
| | | | | |
|:---:|:---:|:---:|:---:|:---:|
@@ -48,100 +48,99 @@
|transparent|
||
-[More themes](https://github.com/vn7n24fzkq/github-profile-summary-cards-example/tree/master/profile-summary-card-output)
+[更多主题](https://github.com/vn7n24fzkq/github-profile-summary-cards-example/tree/master/profile-summary-card-output)
-## How to use (API)
-### Profile details card
+## 如何使用 (API)
+### 简介摘要卡片
`http://github-profile-summary-cards.vercel.app/api/cards/profile-details?username={username}&theme={theme_name}`
-- Accept url parameters
+- 可接收的链接参数
- theme
- Theme name
- username
- Username
-### Top languages used in repository card
+### 仓库首选语言卡片
`http://github-profile-summary-cards.vercel.app/api/cards/repos-per-language?username={username}&theme={theme_name}&exclude={exclude}`
-- Accept url parameters
+- 可接收的参数
- theme
- Theme name
- username
- Username
- exclude:
- - A comma separated list of languages to exclude, e.g., exclude=java,rust,jupyter%20Notebook
- - You can represent a space in the language list by using '%20' when you want to include a space.
- - You can found the supported languages in [here](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml)
+ - 排除以逗号分隔的语言列表, e.g., exclude=java,rust,jupyter%20Notebook
+ - 当语言中有空格时，使用'%20'来表示.
+ - [提供支持的语言](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml)
-### Top languages in commits card
+### 提交首选语言卡片
`http://github-profile-summary-cards.vercel.app/api/cards/most-commit-language?username={username}&theme={theme_name}&exclude={exclude}`
-- Accept url parameters
+- 可接收的参数
- theme
- Theme name
- username
- Username
- exclude:
- - A comma separated list of languages to exclude, e.g., exclude=java,rust,jupyter%20Notebook
- - You can represent a space in the language list by using '%20' when you want to include a space.
- - You can found the supported languages in [here](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml)
+ - 排除以逗号分隔的语言列表, e.g., exclude=java,rust,jupyter%20Notebook
+ - 当语言中有空格时，使用'%20'来表示
+ - [提供支持的语言](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml)
-### GitHub stats card
+### GitHub 状态卡片
`http://github-profile-summary-cards.vercel.app/api/cards/stats?username={username}&theme={theme_name}`
-- Accept url parameters
+- 可接收的参数
- theme
- Theme name
- username
- Username
-### Productive time card
+### 提交时间表卡片
`http://github-profile-summary-cards.vercel.app/api/cards/productive-time?username={username}&theme={theme_name}&utcOffset={utcOffset}`
-- accept url parameters
+- 可接收的参数
- theme
- username
- utcOffset
---
-## How to use (GitHub Actions)
+## 如何使用 (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.
+此操作会生成您的GitHub个人资料摘要卡，并提交到您的存储库。添加此操作后，您还可以自己触发操作。
-:star: [Follow tutorial](https://github.com/vn7n24fzkq/github-profile-summary-cards/wiki/Tutorial) ( Recommendation ) :star:
+:star: [教程](https://github.com/vn7n24fzkq/github-profile-summary-cards/wiki/Tutorial) ( Recommendation ) :star:
-#### First step
+#### 首先
-- You need create a [Personal access token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) with correct permissions.
+- 你需要正确授权的token | [Personal access token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token).
[Personal token](https://github.com/vn7n24fzkq/github-profile-summary-cards/wiki/Tutorial#generate-token)
-- Add personal access token to repo secret.
+- 添加 personal access token 到 repo secret.
-#### Use template ( create a repository )
+#### 使用模版 ( create a repository )
- [github-profile-summary-cards-example](https://github.com/vn7n24fzkq/github-profile-summary-cards-example)
-- Action already setup in this template, you just need click `use this template button` to create your profile readme.
+- Action 已经准备就绪, 点击 `use this template button` 创建个人简介.
-- After replace GITHUB_TOKEN with your repo secret and trigger action you can use everything in `profile-summary-card-output` folder.
+- 在把 GITHUB_TOKEN 替换为你的 repo secret 之后触发 action ，你可以在 `profile-summary-card-output` 下尽情使用.
-#### Add to exist repository
+#### 添加到已经创建的仓库
-- Add this action to repo and replace GITHUB_TOKEN in action yml file with your repo secret.
+- 将此 action 添加到你的仓库， 将你的 GITHUB_TOKEN in action yml file 替换成你的 repo secret.
---
-## GitHub Actions usage
+## GitHub Actions 使用方法
-After the action finished. You can see all of summary cards are in folder which named `profile-summary-card-output`.
+在 action 完成之后. 你可以在 `profile-summary-card-output` 看到所有的摘要卡片.
-`Note: Some summary cards might not be updated in time, because github raw file has cache time.`
+`注意: 一些摘要卡片可能不会及时更新, 因为github原始文件需要缓冲`
```yml
name: GitHub-Profile-Summary-Cards
@@ -177,29 +176,29 @@ jobs:
---
-## 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
+- 需要 `node 16` 版本, 低版本可能会造成问题.
+- 添加 personal access token 到 `.env` 文件. ex: `GITHUB_TOKEN=abcda69ddf66ae95538c5b1666591b59b4abc73a`
+- 代码修改完毕后执行 `npm run build`
```sh
npm run run [username] [UTC offset]
```
-Example
+例如
```sh
npm run run vn7n24fzkq 8
```
-- To locally run the API you can use the vercel dev package
+- 可使用 vercel 开发包本地运行API
```sh
vercel dev
```
-## Deploy your own API on Vercel
-Quickly deploy your own version!
+## 在 Vercel 上部署API
+快速部署
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvn7n24fzkq%2Fgithub-profile-summary-cards&env=GITHUB_TOKEN&envDescription=https%3A%2F%2Fgithub.com%2Fvn7n24fzkq%2Fgithub-profile-summary-cards%23first-step&project-name=my-github-profile-summary-cards)
From a09e2115c6637452f8024ec45748cbb0bf466dc2 Mon Sep 17 00:00:00 2001
From: AIhaisi <144531821+AIhaisi@users.noreply.github.com>
Date: Sun, 6 Apr 2025 10:09:40 +0800
Subject: [PATCH 10/14] Rename README.zh-tw.md to README_zh-tw.md
---
docs/{README.zh-tw.md => README_zh-tw.md} | 0
1 file changed, 0 insertions(+), 0 deletions(-)
rename docs/{README.zh-tw.md => README_zh-tw.md} (100%)
diff --git a/docs/README.zh-tw.md b/docs/README_zh-tw.md
similarity index 100%
rename from docs/README.zh-tw.md
rename to docs/README_zh-tw.md
From f4865aefa878a803c40cb42bf7368b708f859ea1 Mon Sep 17 00:00:00 2001
From: AIhaisi <144531821+AIhaisi@users.noreply.github.com>
Date: Sun, 6 Apr 2025 10:11:02 +0800
Subject: [PATCH 11/14] Update README_zh-tw.md
---
docs/README_zh-tw.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/README_zh-tw.md b/docs/README_zh-tw.md
index 4a970bae7..feacaf788 100644
--- a/docs/README_zh-tw.md
+++ b/docs/README_zh-tw.md
@@ -6,7 +6,7 @@
[](https://github.com/vn7n24fzkq/github-profile-summary-cards/blob/master/LICENSE)
-[繁體中文](./docs/README.zh-tw.md)
+[English](/README.md) | [简体中文](/docs/README_zh.md) | [繁體中文](/docs/README_zh-tw.md)
:star: 這份 repo 是好玩才寫的,任何貢獻都很歡迎！ :star:
From f9696663b27c3f4a9a76cb090227a9d1d93eea44 Mon Sep 17 00:00:00 2001
From: AIhaisi <144531821+AIhaisi@users.noreply.github.com>
Date: Sun, 6 Apr 2025 10:11:25 +0800
Subject: [PATCH 12/14] Update README_zh.md
---
docs/README_zh.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/README_zh.md b/docs/README_zh.md
index 7fa999cc6..8759aa6a9 100644
--- a/docs/README_zh.md
+++ b/docs/README_zh.md
@@ -2,7 +2,7 @@
GitHub Profile Summary Cards
- [English](/README.md) | [简体中文](/docs/README_zh.md) | [繁體中文](/docs/README.zh-tw.md)
+ [English](/README.md) | [简体中文](/docs/README_zh.md) | [繁體中文](/docs/README_zh-tw.md)
GitHub Profile Summary Cards
- [English](/README.md) | [简体中文](/docs/README_zh.md) | [繁體中文](/docs/README.zh-tw.md)
+ [English](/README.md) | [简体中文](/docs/README_zh.md) | [繁體中文](/docs/README_zh-tw.md)
