在您的聽證書上動態生成的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製成。