在您的听证书上动态生成的github统计信息!

查看演示·报告错误·请求功能·FAQ·问问题
français·简体中文·español·deutsch·日本语·portuguêsbrasileiro·italiano·nederlands·nederlands·türkçe
请注意,文档翻译可能已过时;尽可能尝试使用英语文档。
喜欢这个项目?请考虑捐款以帮助其改进!
您是否正在考虑通过向我捐款来支持该项目?请不要!!!
印度最近遭受了最具破坏性的火车事故之一,您的帮助将对受这场悲剧影响的人们非常有价值。
请访问此链接,并进行少量捐款以帮助有需要的人。一小部分捐款走了很长一段路。 ❤️
重要的
由于GitHub API每个用户帐户每小时仅允许5K请求,因此在https://github-readme-stats.vercel.app/api上托管的公共Vercel实例可能会触发速率限制器(请参阅#1471)。我们使用缓存来防止这种情况发生(请参阅https://github.com/anuraghazra/github-readme-stats#common-options)。您可以通过部署自己的Vercel实例来关闭这些速率限制保护措施。
重要的
我们是一个小型团队,要优先考虑,我们依靠投票?我们使用最高问题仪表板来跟踪社区需求(请参阅#1935)。请随时提出问题并提取您感兴趣的请求。我们将首先进行最受欢迎的工作。
复制并将其粘贴到您的销售中,仅此而已。简单的!
将?username=更改为您的github用户名。
[ ![ Anurag's GitHub stats ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra )] ( https://github.com/anuraghazra/github-readme-stats ) 警告
默认情况下,统计卡仅显示诸如公共存储库中的星星,提交和拉的请求之类的统计信息。要在统计卡上显示私人统计信息,您应该使用自己的GitHub API令牌部署自己的实例。
笔记
可用等级为S(最高1%),A+(12.5%),A(25%),A-(37.5%),B+(50%),B(62.5%),B-(75%),C+(87.5%)和C(每个人)。该排名方案基于日本学术分级系统。根据指数和对数正态分布的累积分布函数,将全局百分比计算为每个统计量的加权百分比(提交,拉请,评论,问题,星星和关注者)的加权总和。可以在src/calculaterank.js进行研究。排名上的圈子显示100个减去全球百分位数。
您可以传递查询参数&hide=以隐藏具有逗号分隔值的任何特定统计数据。
选项:
&hide=stars,commits,prs,issues,contribs
![ Anurag's GitHub stats ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=contribs,prs )您可以传递查询参数&show=以显示具有逗号分隔值的任何特定其他统计数据。
选项:
&show=reviews,discussions_started,discussions_answered,prs_merged,prs_merged_percentage
![ Anurag's GitHub stats ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra&show=reviews,discussions_started,discussions_answered,prs_merged,prs_merged_percentage )要启用图标,您可以在查询参数中传递&show_icons=true ,就像这样:
![ Anurag's GitHub stats ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true )使用内置主题,您可以在不进行任何手动自定义的情况下自定义卡的外观。
使用&theme=THEME_NAME参数类似:
![ Anurag's GitHub stats ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=radical ) GitHub Readme统计数据带有几个内置主题(例如dark , radical , merko , gruvbox , tokyonight , onedark , cobalt ,Synthwave, synthwave , highcontrast , dracula )。
您可以查看所有可用主题的预览或结帐主题配置文件。请注意,我们暂停了增加新主题以减少维护工作;所有与新主题有关的拉动请求都将关闭。
由于GitHub将重新上传卡并从其CDN中提供它们,因此我们无法推断服务器端的浏览器/GitHub主题。但是,您可以使用四种方法在客户端创建动态主题。
我们包括一个具有透明背景的transparent主题。该主题被优化,可以在Github的黑暗和轻默认主题上看起来不错。您可以使用&theme=transparent参数启用此主题:
![ Anurag's GitHub stats ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=transparent )您可以使用bg_color参数使任何可用的主题透明。这是通过将bg_color设置为具有透明alpha通道(即bg_color=00000000 )的颜色来完成的:
![ Anurag's GitHub stats ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&bg_color=00000000 )您可以使用GitHub的主题上下文标签根据用户GitHub主题自动切换主题。这是通过将#gh-dark-mode-only或#gh-light-mode-only添加到图像URL末尾来完成的。此标签将定义在降价中指定的图像仅使用灯或深色github主题显示给观众:
[ ![ Anurag's GitHub stats-Dark ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=dark#gh-dark-mode-only )] ( https://github.com/anuraghazra/github-readme-stats#gh-dark-mode-only )
[ ![ Anurag's GitHub stats-Light ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=default#gh-light-mode-only )] ( https://github.com/anuraghazra/github-readme-stats#gh-light-mode-only )您可以在HTML中使用GitHub的新媒体功能来指定是否显示光或黑暗主题的图像。这是使用HTML <picture>元素与prefers-color-scheme媒体功能结合使用的。
< picture >
< source
srcset =" https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=dark "
media =" (prefers-color-scheme: dark) "
/>
< source
srcset =" https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true "
media =" (prefers-color-scheme: light), (prefers-color-scheme: no-preference) "
/>
< img src =" https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true " />
</ picture >您可以使用URL参数自定义所有卡的外观。
| 姓名 | 描述 | 类型 | 默认值 |
|---|---|---|---|
title_color | 卡的标题颜色。 | 字符串(十六进制颜色) | 2f80ed |
text_color | 身体文字颜色。 | 字符串(十六进制颜色) | 434d58 |
icon_color | 图标颜色(如果有)。 | 字符串(十六进制颜色) | 4c71f2 |
border_color | 卡的边框颜色。启用hide_border时不应用。 | 字符串(十六进制颜色) | e4e2e2 |
bg_color | 卡的背景颜色。 | 字符串(十六进制颜色或角度形式的梯度,开始,结束) | fffefe |
hide_border | 隐藏了卡的边界。 | 布尔 | false |
theme | 主题的名称,从所有可用主题中选择。 | 枚举 | default |
cache_seconds | 手动设置缓存标头(最小:21600,最大:86400)。 | 整数 | 21600 |
locale | 在卡中设置语言,您可以在此处查看可用语言的完整列表。 | 枚举 | en |
border_radius | 卡在卡上的圆形。 | 数字 | 4.5 |
警告
我们使用缓存来减少服务器上的负载(请参阅#1471(注释))。我们的卡的默认缓存为6小时(21600秒)。另外,请注意,缓存至少为6小时,最多24小时。如果您需要更频繁地更新统计卡上的数据,则可以将自己的实例和设置环境变量CACHE_SECONDS设置为选择的值。
您可以在BG_Color选项中提供多个逗号分隔的值,以呈现以下格式的梯度:
&bg_color=DEG,COLOR1,COLOR2,COLOR3...COLOR10
这是所有可用地区的清单:
|
|
|
如果我们不支持您的语言,请考虑贡献!您可以在我们的贡献指南中找到有关如何执行此操作的更多信息。
| 姓名 | 描述 | 类型 | 默认值 |
|---|---|---|---|
hide | 隐藏统计数据中指定的项目。 | 字符串(逗号分隔值) | null |
hide_title | 隐藏您的统计卡标题。 | 布尔 | false |
card_width | 手动设置卡的宽度。 | 数字 | 500px (approx.) |
hide_rank | 隐藏等级并自动调整卡宽度。 | 布尔 | false |
rank_icon | 显示替代等级图标(即github , percentile或default )。 | 枚举 | default |
show_icons | 显示几乎所有统计数据的图标。 | 布尔 | false |
include_all_commits | 计数总投入,而不仅仅是当年提交。 | 布尔 | false |
line_height | 设置文本之间的线高。 | 整数 | 25 |
exclude_repo | 不包括指定的存储库。 | 字符串(逗号分隔值) | null |
custom_title | 设置该卡的自定义标题。 | 细绳 | <username> GitHub Stats |
text_bold | 使用粗体文字。 | 布尔 | true |
disable_animations | 禁用卡中的所有动画。 | 布尔 | false |
ring_color | 等级圆的颜色。 | 字符串(十六进制颜色) | 2f80ed |
number_format | 在两种可用格式之间进行切换,以显示short卡值(IE 6.6k )和long (即6626 )。 | 枚举 | short |
show | 在统计卡上显示其他项目(即reviews , discussions_started , discussions_answered , prs_merged或prs_merged_percentage )。 | 字符串(逗号分隔值) | null |
笔记
当hide_rank = true时,最小卡宽度为270 px +标题长度和填充。
| 姓名 | 描述 | 类型 | 默认值 |
|---|---|---|---|
show_owner | 显示回购的所有者名称。 | 布尔 | false |
description_lines_count | 手动设置描述的行数。指定的值将在1到3之间夹住。如果未指定此参数,则将根据描述的实际长度自动调整行数。 | 数字 | null |
| 姓名 | 描述 | 类型 | 默认值 |
|---|---|---|---|
show_owner | 显示要旨的所有者名称。 | 布尔 | false |
| 姓名 | 描述 | 类型 | 默认值 |
|---|---|---|---|
hide | 隐藏卡中的指定语言。 | 字符串(逗号分隔值) | null |
hide_title | 隐藏卡的标题。 | 布尔 | false |
layout | 在五个可用布局之间的开关normal与compact和donut和donut-vertical与pie 。 | 枚举 | normal |
card_width | 手动设置卡的宽度。 | 数字 | 300 |
langs_count | 在1-20之间显示更多语言。 | 整数 | 5对于normal和donut ,其他布局6 |
exclude_repo | 不包括指定的存储库。 | 字符串(逗号分隔值) | null |
custom_title | 设置该卡的自定义标题。 | 细绳 | Most Used Languages |
disable_animations | 禁用卡中的所有动画。 | 布尔 | false |
hide_progress | 使用紧凑的布局选项,隐藏百分比并删除条。 | 布尔 | false |
size_weight | 配置语言统计算法(请参阅语言统计算法)。 | 整数 | 1 |
count_weight | 配置语言统计算法(请参阅语言统计算法)。 | 整数 | 0 |
警告
语言名称应被划分为编码百分比(即: c++应成为c%2B%2B , jupyter notebook应该成为jupyter%20notebook等)。您可以使用urlencoder.org来帮助您自动执行此操作。
| 姓名 | 描述 | 类型 | 默认值 |
|---|---|---|---|
hide | 隐藏从卡中指定的语言。 | 字符串(逗号分隔值) | null |
hide_title | 隐藏卡的标题。 | 布尔 | false |
line_height | 设置文本之间的线高。 | 整数 | 25 |
hide_progress | 隐藏进度条和百分比。 | 布尔 | false |
custom_title | 设置该卡的自定义标题。 | 细绳 | WakaTime Stats |
layout | 在两个可用布局default和compact之间进行切换。 | 枚举 | default |
langs_count | 限制卡上的语言数量,默认为所有报告的语言。 | 整数 | null |
api_domain | 为卡设置自定义API域,例如使用Hakatime或Wakapi之类的服务 | 细绳 | wakatime.com |
display_format | 设置Wakatime Stats显示格式。选择显示基于时间的统计数据或percent以显示百分比的time 。 | 枚举 | time |
disable_animations | 禁用卡中的所有动画。 | 布尔 | false |
github额外的引脚允许您使用github readme配置文件在个人资料中固定超过6个存储库。
耶!您不再限于6个固定存储库。
将此代码复制到您的会员中,然后更改链接。
端点: api/pin?username=anuraghazra&repo=github-readme-stats
[ ![ Readme Card ] ( https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats )] ( https://github.com/anuraghazra/github-readme-stats )使用show_owner查询选项以包括回购的所有者用户名
GitHub Gist Pins允许您使用GitHub ReadMe配置文件将GIST固定在GitHub配置文件中。
将此代码复制到您的会员中,然后更改链接。
端点: api/gist?id=bbfce31e0217a3689c8d961a356cb10d
[ ![ Gist Card ] ( https://github-readme-stats.vercel.app/api/gist?id=bbfce31e0217a3689c8d961a356cb10d )] ( https://gist.github.com/Yizack/bbfce31e0217a3689c8d961a356cb10d/ )使用Show_owner查询选项以包括要点的所有者用户名
顶级语言卡显示了GitHub用户最常用的语言。
警告
默认情况下,语言卡仅显示公共存储库的语言结果。要包括私人存储库中使用的语言,您应该使用自己的github api代币部署自己的实例。
笔记
顶级语言并未指示用户的技能水平或类似的技能;这是一个GitHub度量,以确定哪些语言在GitHub上具有最多的代码。这是Github-Readme-Stats的新功能。
警告
该卡仅在您自己的非猎物存储库中显示语言使用量,而不是取决于提交的作者是谁。它不包括您在其他用户/组织存储库中的贡献。当前无法从GitHub API获取这些数据。如果您希望改进此行为,则可以支持@rickstaa在GitHub社区中创建的此功能请求。
警告
当前,此卡仅显示有关前100个存储库的数据。这是因为GitHub API的限制会导致公共实例降低的时间(请参阅#1471)。将来,通过释放GitHub动作或为用户自己的实例提供环境变量来改善此行为。
将此代码复制到您的会员中,然后更改链接。
端点: api/top-langs?username=anuraghazra
[ ![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra )] ( https://github.com/anuraghazra/github-readme-stats )我们使用以下算法来计算语言卡上的语言百分比:
ranking_index = ( byte_count ^ size_weight ) * ( repo_count ^ count_weight )默认情况下,仅使用字节计数用于确定语言卡上显示的语言百分比(即size_weight=1和count_weight=0 )。但是,您可以使用&size_weight= and &count_weight=选项来加权语言使用计算。值必须是正实数。有关该算法的更多详细信息,请参见此处。
&size_weight=1&count_weight=0 (默认)按字节计数订单。&size_weight=0.5&count_weight=0.5 - (建议)使用字节和repo计数进行排名&size_weight=0&count_weight=1订单由repo count ![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&size_weight=0.5&count_weight=0.5 )您可以使用&exclude_repo=repo1,repo2参数来排除单个存储库。
![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&exclude_repo=github-readme-stats,anuraghazra.github.io )您可以使用&hide=language1,language2参数来隐藏单个语言。
![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&hide=javascript,html )您可以使用&langs_count=选项来增加或减少卡上显示的语言数量。有效值是1到20之间的整数(包括)。默认情况下,它设置为normal和donut 5 ,其他布局为6 。
![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&langs_count=8 )您可以使用&layout=compact选项来更改卡设计。
![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=compact )您可以使用&layout=donut选项来更改卡设计。
[ ![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=donut )] ( https://github.com/anuraghazra/github-readme-stats )您可以使用&layout=donut-vertical选项来更改卡设计。
[ ![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=donut-vertical )] ( https://github.com/anuraghazra/github-readme-stats )您可以使用&layout=pie选项来更改卡设计。
[ ![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=pie )] ( https://github.com/anuraghazra/github-readme-stats )您可以使用&hide_progress=true选项隐藏百分比和进度条(布局将自动设置为compact )。
![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&hide_progress=true )警告
请注意,我们目前仅显示公开的Wakatime配置文件的数据。因此,您必须确保公开Display code time publicly和Display languages, editors, os, categories publicly 。
将?username=更改为您的Wakatime用户名。
[ ![ Harlok's WakaTime stats ] ( https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs )] ( https://github.com/anuraghazra/github-readme-stats )从任何默认主题中选择
默认情况下,Github不会并排布置卡片。为此,您可以使用此方法:
< a href =" https://github.com/anuraghazra/github-readme-stats " >
< img height = 200 align =" center " src =" https://github-readme-stats.vercel.app/api?username=anuraghazra " />
</ a >
< a href =" https://github.com/anuraghazra/convoychat " >
< img height = 200 align =" center " src =" https://github-readme-stats.vercel.app/api/top-langs?username=anuraghazra&layout=compact&langs_count=8&card_width=320 " />
</ a > < a href =" https://github.com/anuraghazra/github-readme-stats " >
< img align =" center " 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 =" center " src =" https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=convoychat " />
</ a >由于GitHub API仅允许每小时5K请求,因此我的https://github-readme-stats.vercel.app/api可能会达到速率限制器。如果您在自己的Vercel服务器上托管它,则不必担心任何事情。单击部署按钮开始!
笔记
由于#58,我们应该能够处理超过5K的请求,并且停机时间较少?
笔记
如果您正在使用Pro(IE付费)Vercel计划,则可以在卡塞尔(Vercel)中找到的最大值值。建议您将此值保持在30秒以下,以防止高内存使用。
Log in 。Continue with GitHub登录。Add New...按钮,然后选择Project选项。Continue with GitHub ,搜索所需的Git存储库,然后单击Import按钮导入它。另外,您可以使用Import Third-Party Git Repository ->存储库。repo和user权限(这允许访问可以查看私人回购和用户统计信息)。PAT_1的环境变量(如图所示)。警告
这种使用GRS的方式不得到正式支持,并添加了用于无法使用Vercel的某些特定用例(例如#2341)。因此,对此方法的支持是有限的。
express添加到package.json的依赖项部分github-readme-stats/package.json
BA7C2F8中的第54至61行
npm i如果需要)(初始设置)node express.js启动服务器,或将输入点设置为package.json中的express.jsgithub-readme-stats/package.json
BA7C2F8中的第11行
github readme统计数据包含几个可用于删除速率限制保护措施的Vercel环境变量:
CACHE_SECONDS :此环境变量优先于我们的最低最小值和最大值,并可以为自托管的动词实例规避这些值。请参阅有关将这些环境变量添加到您的Vercel实例的文档。
您可以使用github的同步叉按钮来保持叉子,从而将私有Vercel实例与上游保持最新。您还可以使用@Wei创建的拉包来自动化此过程。
我几乎可以为所有能够使用这些项目提供帮助。显然,这需要时间。您可以免费使用此服务。
但是,如果您正在使用此项目,或者只是想鼓励我继续创建东西,那么您可以通过几种方法来做:
谢谢! ❤️
欢迎捐款! <3
用❤️和JavaScript制成。