READMESで動的に生成されたGitHub統計を取得してください!

デモの表示・レポートバグ・リクエスト機能・FAQ・質問する
français・简体中文・español・deutsch・日本語・portuguêsBrasileiro・Italiano・한국어・Nederlands・Nederlands・türkçe
ドキュメントの翻訳は時代遅れである可能性があることに注意してください。可能であれば、英語のドキュメントを使用してみてください。
プロジェクトが好きですか?改善を支援するために寄付を検討してください!
私に寄付してプロジェクトをサポートすることを検討していますか?しないでください!!!
インドは最近、最も壊滅的な列車事故の1つに苦しんでおり、あなたの助けはこの悲劇の影響を受けた人々にとって非常に価値があります。
このリンクにアクセスして、困っている人々を支援するために少量の寄付をしてください。少額の寄付は大いに役立ちます。 ❤❤️
重要
GitHub APIはユーザーアカウントごとに1時間あたり5Kリクエストのみを許可しているため、 https://github-readme-stats.vercel.app/apiでホストされているパブリックVercelインスタンスは、レートリミッターにヒットする可能性があります(#1471を参照)。キャッシュを使用して、これが発生しないようにします(https://github.com/anuraghazra/github-readme-stats#common-optionsを参照)。独自のVercelインスタンスを展開することにより、これらのレート制限保護をオフにできます。
重要
私たちは小さなチームであり、優先順位を付けるために、私たちはupvotesに依存していますか?コミュニティの需要を追跡するために、TOP Issuesダッシュボードを使用します(#1935を参照)。あなたが興味を持っている問題を繰り返し、リクエストをプルすることをheしないでください。私たちは最初に最も支持されたものに取り組みます。
これをコピーしてマークダウンに貼り付けます。それだけです。単純!
githubユーザー名に?username= value」を変更します。
[ ![ 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 )アイコンを有効にするには、Query Paramで合格して&show_icons=trueを実行できます。
![ Anurag's GitHub stats ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true )組み込みテーマを使用すると、手動のカスタマイズを行わずにカードの外観をカスタマイズできます。
use &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 、 highcontrast 、 dracula )。
利用可能なすべてのテーマのプレビューを見るか、テーマ構成ファイルをチェックアウトできます。メンテナンスの取り組みを減らすために、新しいテーマの追加を一時停止したことに注意してください。新しいテーマに関連するすべてのプル要求は閉じられます。
Githubはカードを再アップロードし、CDNからそれらを提供するため、サーバー側のブラウザ/Githubテーマを推測することはできません。ただし、クライアント側にダイナミクステーマを作成するために使用できる4つの方法があります。
透明な背景を持つ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=00000000 )でbg_color色に設定することによって行われます。
![ 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で行われます。このタグは、マークダウンで指定された画像が、ライトまたは暗い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 | キャッシュヘッダーを手動で設定します(min:21600、max: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 (すなわち6.6k )とlong (つまり6626 )を表示するための2つの使用可能な形式の間を切り替えます。 | 列挙 | 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 | GISTの所有者名を表示します。 | ブール | false |
| 名前 | 説明 | タイプ | デフォルト値 |
|---|---|---|---|
hide | カードから指定された言語を隠します。 | 文字列(コンマセパートされた値) | null |
hide_title | カードのタイトルを隠します。 | ブール | false |
layout | 5つの利用可能なレイアウトnormal & compact & donut & donut-vertical & pieの切り替え。 | 列挙 | normal |
card_width | カードの幅を手動で設定します。 | 番号 | 300 |
langs_count | 1〜20の間に、カード上のより多くの言語を表示します。 | 整数 | 5 normal donutの場合は5 、他のレイアウトの場合は6 |
exclude_repo | 指定されたリポジトリを除外します。 | 文字列(コンマセパートされた値) | null |
custom_title | カードのカスタムタイトルを設定します。 | 弦 | Most Used Languages |
disable_animations | カード内のすべてのアニメーションを無効にします。 | ブール | false |
hide_progress | コンパクトレイアウトオプションを使用し、パーセンテージを隠し、バーを削除します。 | ブール | false |
size_weight | 言語統計アルゴリズムを構成します(言語統計アルゴリズムを参照)。 | 整数 | 1 |
count_weight | 言語統計アルゴリズムを構成します(言語統計アルゴリズムを参照)。 | 整数 | 0 |
警告
言語名はURI-ESCAPEDである必要があります。パーセントエンコーディングで指定されているように(つまり、 c++ c%2B%2Bになるはずです。JupyterNotebook jupyter notebook jupyter%20notebookなどになります)。
| 名前 | 説明 | タイプ | デフォルト値 |
|---|---|---|---|
hide | カードから指定された言語を隠します。 | 文字列(コンマセパートされた値) | null |
hide_title | カードのタイトルを隠します。 | ブール | false |
line_height | テキスト間の線の高さを設定します。 | 整数 | 25 |
hide_progress | 進行状況バーとパーセンテージを隠します。 | ブール | false |
custom_title | カードのカスタムタイトルを設定します。 | 弦 | WakaTime Stats |
layout | 利用可能な2つのレイアウトのdefaultとcompact間の切り替え。 | 列挙 | default |
langs_count | カード上の言語の数を制限し、デフォルトで報告されたすべての言語にデフォルトです。 | 整数 | null |
api_domain | たとえば、HakatimeやWakapiなどのサービスを使用するために、カードのカスタムAPIドメインを設定します | 弦 | wakatime.com |
display_format | Wakatime Statsディスプレイ形式を設定します。時間ベースの統計またはpercentを表示するtimeを選択して、割合を表示します。 | 列挙 | time |
disable_animations | カード内のすべてのアニメーションを無効にします。 | ブール | false |
GitHub Extra Pinsを使用すると、GitHub ReadMeプロファイルを使用して、プロファイルに6つ以上のリポジトリをピン留めできます。
わーい! 6つのピン留めリポジトリに制限されなくなりました。
このコードをreadmeにコピーしてリンクを変更します。
endpoint: 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プロファイルを使用してGitHubプロファイルにGistをピン留めできます。
このコードをreadmeにコピーしてリンクを変更します。
エンドポイント: api/gist?id=bbfce31e0217a3689c8d961a356cb10d
[ ![ Gist Card ] ( https://github-readme-stats.vercel.app/api/gist?id=bbfce31e0217a3689c8d961a356cb10d )] ( https://gist.github.com/Yizack/bbfce31e0217a3689c8d961a356cb10d/ )show_ownerクエリオプションを使用して、gistの所有者のユーザー名を含める
トップ言語カードには、GitHubユーザーの最も頻繁に使用される言語が表示されます。
警告
デフォルトでは、言語カードには、公開リポジトリからのみ言語の結果が表示されます。プライベートリポジトリで使用される言語を含めるには、独自のGitHub APIトークンを使用して独自のインスタンスを展開する必要があります。
注記
トップ言語は、ユーザーのスキルレベルなどを示していません。 Githubで最もコードが最も多い言語を決定するのはGitHubメトリックです。 Github-readme-statsの新機能です。
警告
このカードは、コミットの著者が誰であるかに依存するのではなく、独自の非フォークリポジトリ内でのみ言語の使用を示しています。他のユーザー/組織リポジトリへの貢献は含まれていません。現在、GitHub APIからこのデータを取得する方法はありません。この動作を改善したい場合は、GitHubコミュニティ内の@rickstaaによって作成されたこの機能要求をサポートできます。
警告
現在、このカードには、最初の100個のリポジトリについてのデータのみが表示されます。これは、公共インスタンスのダウンタイムを引き起こすGitHub APIの制限が原因です(#1471を参照)。将来、この動作は、GitHubアクションをリリースするか、ユーザー独自のインスタンスに環境変数を提供することにより改善されます。
このコードをreadmeにコピーしてリンクを変更します。
エンドポイント: 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= optionsを使用して、言語使用量の計算を重み付けることができます。値は正の実数でなければなりません。アルゴリズムの詳細については、こちらをご覧ください。
&size_weight=1&count_weight=0 (デフォルト)バイトカウントによる注文。&size_weight=0.5&count_weight=0.5 (推奨)ランキングにバイトとレポの両方のカウントを使用します&size_weight=0&count_weight=1リポジトリによる注文 ![ 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 )警告
現在、公開されているワカティタイムプロファイルのデータのみを表示していることに注意してください。したがって、両方がDisplay code time publicly 、 Display languages, editors, os, categories publicly公開することを確認する必要があります。
wakatimeユーザー名に?username= value」を変更します。
[ ![ 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は1時間あたり5Kリクエストのみを許可するため、 https://github-readme-stats.vercel.app/apiがレートリミッターにヒットする可能性があります。独自のVercelサーバーでホストする場合、何も心配する必要はありません。展開ボタンをクリックして開始してください!
注記
#58以来、5K以上のリクエストを処理し、ダウンタイムの問題が少ないはずです。
注記
Pro(IE Paid)Vercel Planを使用している場合、Vercel.jsonで見つかった最大値の値を、カードリクエスト中に頻繁に頻繁に出てくると増加させることができます。メモリの使用量が高いことを防ぐために、この値を30秒未満に保つことをお勧めします。
Log inをクリックします。Continue with GitHubにサインインします。Add New...ボタンをクリックし、[ Projectオプションを選択します。Continue with GitHubをクリックし、必要なgitリポジトリを検索し、 Importボタンをクリックしてインポートします。または、 Import Third-Party Git Repository -> Gitリポジトリをインポートできます。repoとuser許可を有効にします(これにより、アクセスがプライベートレポとユーザーの統計情報を表示できます)。PAT_1という名前の環境変数として追加します(図のように)。警告
GRSの使用方法は公式にサポートされておらず、Vercelを使用できない特定のユースケースに応えるために追加されました(例:#2341)。したがって、この方法のサポートは限られています。
package.jsonの依存関係セクションにexpressを追加しますgithub-readme-stats/package.json
BA7C2F8の54〜61行
npm iを実行します(初期セットアップ)node express.jsを実行してサーバーを起動するか、 express.jsにエントリポイントをpackage.jsonに設定して、マネージドサービスに展開している場合はgithub-readme-stats/package.json
BA7C2F8の11行
Github Readme Statsには、レート制限保護を削除するために使用できるいくつかのVercel環境変数が含まれています。
CACHE_SECONDS :この環境変数は、キャッシュの最小値と最大値よりも優先され、自己ホストされたVercelインスタンスのこれらの値を回避できます。これらの環境変数をVercelインスタンスに追加するvercelドキュメントを参照してください。
フォークを保持することができます。したがって、GitHubの同期フォークボタンを使用して、アップストリームでプライベートVercelインスタンスを最新の状態に保ちます。 @weiによって作成されたプルパッケージを使用して、このプロセスを自動化することもできます。
私はできる限りすべてのものをオープンソースし、これらのプロジェクトを使用して助けを必要とするすべての人に返信しようとします。明らかに、これには時間がかかります。このサービスを無料で使用できます。
ただし、このプロジェクトを使用していて、それに満足している場合、または単に作品を作成し続けるように勧めたい場合は、それを行う方法がいくつかあります。
ありがとう! ❤❤️
貢献は大歓迎です! <3
❤️とjavaScriptで作られています。