13 KiB
GitHub Readme Stats
在你的 README 中获取动态生成的 GitHub 统计信息！
喜欢这个项目？请考虑捐赠来帮助它完善！
特性
GitHub 统计卡片
将这行代码复制到你的 markdown 文件中，就是如此简单！
更改 ?username= 的值为你的 GitHub 用户名。
[](https://github.com/anuraghazra/github-readme-stats)
注: 等级基于用户的统计信息计算得出，详见 src/calculateRank.js
隐藏个别统计项
想要隐藏指定统计信息，你可以调用参数 ?hide=，其值用 , 分隔。
选项：
&hide=stars,commits,prs,issues,contribs
将私人项目贡献添加到总提交计数中
你可以使用参数 ?count_private=true 把私人贡献计数添加到总提交计数中。
注：如果你是自己部署本项目，私人贡献将会默认被计数，如果不是自己部署，你需要分享你的私人贡献计数。
Options:
&count_private=true
显示图标
如果想要显示图标，你可以调用 show_icons=true 参数，如下：
主题
你可以通过现有的主题进行卡片个性化，省去手动自定义的麻烦。
通过调用 ?theme=THEME_NAME 参数，像这样：
所有现有主题
dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula
在 theme config 文件 中查看更多主题，或者你可以 贡献新的主题 :D
自定义
你可以通过使用 URL 参数的方式，为你的 Stats Card 或 Repo Card 自定义样式。
自定义选项：
| Option | type | description | Stats Card (default) | Repo Card (default) | Top Lang Card (default) |
|---|---|---|---|---|---|
| title_color | hex color | 标题颜色 | 2f80ed | 2f80ed | 2f80ed |
| text_color | hex color | 字体颜色 | 333 | 333 | 333 |
| icon_color | hex color | 图标颜色 | 4c71f2 | 586069 | 586069 |
| bg_color | hex color | 卡片背景颜色 | FFFEFE | FFFEFE | FFFEFE |
| line_height | number | 文字行高 | 30 | N/A | N/A |
| hide | CSV | 隐藏指定统计项 | undfined | N/A | undefined |
| hide_rank | boolean | 隐藏评分等级 | false | N/A | N/A |
| hide_title | boolean | 隐藏卡片标题 | false | N/A | false |
| hide_border | boolean | 隐藏卡片边框 | false | N/A | N/A |
| show_owner | boolean | 显示 Repo 卡片所属账户用户名 | N/A | false | N/A |
| show_icons | boolean | 显示图标 | false | N/A | N/A |
| theme | string | 设置主题 | 'default' | 'default_repocard' | 'default' |
| cache_seconds | number | 手动设置自定义缓存控制 | 1800 | 1800 | 1800 |
| count_private | boolean | 统计私人贡献计数 | false | N/A | N/A |
| layout | string | 布局方式 | N/A | N/A | 'default' |
注意缓存：Repo 卡片默认缓存 30 分钟，如果 fork 数和 star 数小于 1k ，则默认为 2 小时。缓存被限制为最少 30 分钟，最长 24 小时。
GitHub 更多置顶
GitHub 更多置顶 让你使用 README Profile，在个人页面中置顶多于 6 个 repo 。
这波可以！你再也不用受限于最多 6 个置顶了。
使用细则
复制粘贴这段代码到你的 README 文件中，并更改链接。
Endpoint: api/pin?username=anuraghazra&repo=github-readme-stats
[](https://github.com/anuraghazra/github-readme-stats)
Demo
使用 show_owner 变量将 Repo 所属账户的用户名包含在内。
热门语言卡片
热门语言卡片显示了 GitHub 用户常用的编程语言。
注意：热门语言并不表示我的技能水平或类似的水平，它是用户在 GitHub 上拥有最多代码的一项指标，它是 github-readme-stats 的新功能
使用细则
将此代码复制粘贴到您的README.md文件中，并修改链接。
Endpoint: api/top-langs?username=anuraghazra
[](https://github.com/anuraghazra/github-readme-stats)
隐藏特定语言
可以使用?hide=语言1,语言2参数来隐藏指定的语言。
[](https://github.com/anuraghazra/github-readme-stats)
紧凑的语言卡片布局
你可以使用 &layout=compact 参数来改变卡片的样式。
[](https://github.com/anuraghazra/github-readme-stats)
Demo
- 紧凑布局
全部 Demo
- 默认
- 隐藏特定数据
- 显示图标
- 主题
从 默认主题 中进行选择
- 自定义统计卡片
- 自定义代码库卡片
- 热门语言
提示 (对齐 Repo 卡片)
你通常无法将图片靠边显示。为此，您可以使用以下方法：
<a href="https://github.com/anuraghazra/github-readme-stats">
<img align="left" src="https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats" />
</a>
<a href="https://github.com/anuraghazra/convoychat">
<img align="left" src="https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=convoychat" />
</a>
自己部署
因为 GitHub 的 API 每个小时只允许 5 千次请求，我的 https://github-readme-stats.vercel.app/api 很有可能会触发限制
如果你将其托管在自己的 Vercel 服务器上，那么你就不必为此担心。点击 deploy 按钮来开始你的部署！
注意: 从 #58 开始，我们应该能够处理超过 5 千 的请求，并且不会出现宕机问题 :D
设置 Vercel 的指导
- 前往 vercel.com
- 点击
Log in
- 点击
Continue with GitHub通过 GitHub 进行登录
- 登录 GitHub 并允许访问所有存储库（如果系统这样提示）
- Fork 这个仓库
- 返回到你的 Vercel dashboard
- 选择
Import Project
- 选择
Import Git Repository
- 选择 root 并将所有内容保持不变，并且只需添加名为 PAT_1 的环境变量（如图所示），其中将包含一个个人访问令牌（PAT），你可以在这里轻松创建（保留默认，并且只需要命名下，名字随便）
- 点击 deploy，这就完成了，查看你的域名就可使用 API 了！
💖 支持这个项目
我尽己所能地进行开源，并且我尽量回复每个在使用项目时需要帮助的人。很明显，这需要时间，但你可以免费享受这些。
然而, 如果你正在使用这个项目并感觉良好，或只是想要支持我继续开发，你可以通过如下方式：
- 在你的 README 中使用 github-readme-stats 时，链接指向会这里 :D
- Star 并 分享这个项目 🚀
- 你可以通过 PayPal 一次性捐款. 我多半会买一杯 咖啡茶。🍵
谢谢！ ❤️
欢迎贡献！ <3
用 ❤️ 发电，用 JavaScript 制作。