17 KiB
GitHub Readme Stats
あなたの README に自動生成された GitHub の統計情報を載せましょう！
View Demo · Report Bug · Request Feature
Français · 简体中文 · Español · Deutsch · 日本語 · Português Brasileiro · Italiano · 한국어
このプロジェクトを気に入っていただけましたか？
もしよろしければ、プロジェクトのさらなる改善のために寄付を検討して頂けると嬉しいです！
主な機能
GitHub Stats Card
以下のコードをコピーして、あなたの Markdown ファイルに貼り付けるだけです。 簡単ですね！
?username= の値は、あなたの GitHub アカウントのユーザー名に変更してください。
[](https://github.com/anuraghazra/github-readme-stats)
Note: カードに表示されるランクはユーザの統計情報に基づいて計算されています。詳しくは、src/calculateRank.jsをご覧ください。
特定の統計情報を隠す
クエリパラメータ ?hide= に値をカンマ区切りで渡すことで、特定の統計情報を隠すことができます。
Options:
&hide=stars,commits,prs,issues,contribs
プライベートリポジトリへのコミットをカウントする
クエリパラメータ ?count_private=true を使用することで、プライベートリポジトリへのコミット数を総数に追加することができます。
Note: このプロジェクトを自分でデプロイしている場合、デフォルトではプライベートリポジトリへのコミットがカウントされます。
Options:
&count_private=true
アイコンを表示する
クエリパラメータ ?show_icons=true を使用することで、アイコンの表示が有効になります。
テーマの変更
内蔵されているテーマを使用すれば、手動のカスタマイズを行うことなくカードの外観を変更することができます。
?theme=THEME_NAME は以下のように使います。
内蔵テーマの一覧
dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula
その他の使用可能なテーマのプレビューや設定ファイルもご覧ください。もしよろしければ、新しいテーマを投稿してみてください 😄
テーマを自分でカスタマイズする
Stats Card や Repo Card の外観を URL パラメータを使って好きなようにカスタマイズすることができます。
共通のオプション
title_color- タイトルの色 (16 進数カラーコード)text_color- 中身のテキストの色 (16 進数カラーコード)icon_color- アイコンの色（変更可能な場合のみ） (16 進数カラーコード)bg_color- 背景の色 (16 進数カラーコード) または angle,start,end の形式でグラデーションを指定することも可theme- 使用可能なテーマ一覧 から選んだテーマ名cache_seconds- キャッシュ時間の秒数 (最小値: 1800, 最大値: 86400)
bg_color の グラデーション指定
bg_color オプションで複数のカンマ区切りの値を指定してグラデーションをレンダリングすることができます。フォーマットは以下の通りになります。
&bg_color=DEG,COLOR1,COLRO2,COLOR3...COLOR10
キャッシュに関する注意点: Repo cards のデフォルトのキャッシュは、フォーク数とスター数が 1k 未満の場合は 30 分(1800 秒) で、それ以外の場合は 2 時間(7200) です。また、キャッシュは最低でも 30 分、最大でも 24 時間に制限されていることに注意してください。
Stats Card だけに存在するオプション
hide- 特定の統計情報を隠す (カンマ区切りで指定)hide_title- (boolean)hide_rank- (boolean)show_icons- (boolean)include_all_commits- 今年度のコミット数だけでなく、コミット数の総数をカウントする (boolean)count_private- プライベートリポジトリへのコミットをカウントする (boolean)line_height- テキストの行の高さ (number)
Repo Card だけに存在するオプション
show_owner- リポジトリのオーナーを表示する (boolean)
Language Card だけに存在するオプション
hide- 特定の言語を隠す (カンマ区切りで指定)hide_title- (boolean)layout-defaultかcompactのいずれかのレイアウトに切り替えるcard_width- カードの横幅 (number)
⚠️ 重要:
Percent Encoding で指定されているように、プログラミング言語の名前は URL エンコードされている必要があります。 (例:c++はc%2B%2B,jupyter notebookはjupyter%20notebook, など)
GitHub Extra Pins
GitHub extra pins を使うと、GitHub の readme プロフィールを使って、自分のプロフィールに 6 つ以上のリポジトリをピン留めすることができます。
やったー! もはや、リポジトリをピン留めできる数が 6 つに制限されることはありません。
使い方
以下のコードをあなたの readme にコピー & ペーストし、リンクを変更してください。
エンドポイント: api/pin?username=anuraghazra&repo=github-readme-stats
[](https://github.com/anuraghazra/github-readme-stats)
デモ
リポジトリのオーナーのユーザー名を含める場合は、show_owner 変数を使用します。
Top Languages Card
Top languages card には、その GitHub ユーザーが最も利用している Top languages が表示されます。
NOTE: Top languages は、ユーザのスキルレベルを示すものではなく、GitHub 上でどの言語で最も多くのコードを書いているかを示す GitHub の指標です。
使い方
以下のコードをあなたの readme にコピー & ペーストし、リンクを変更してください。
エンドポイント: api/top-langs?username=anuraghazra
[](https://github.com/anuraghazra/github-readme-stats)
特定の言語を隠す
クエリパラメータ ?hide=language1,language2 使用することで、特定の言語を非表示にすることができます。
[](https://github.com/anuraghazra/github-readme-stats)
レイアウトをコンパクトにする
クエリパラメータ &layout=compact を使用することで、カードのデザインを変更することができます。
[](https://github.com/anuraghazra/github-readme-stats)
デモ
- Compact layout の場合
全てのデモ
- デフォルト
- 特定の統計情報を隠す
- アイコンを表示する
- コミット数の総数をカウントする
- テーマの変更
任意のテーマを選択できます。
- グラデーション
- stats card のカスタマイズ
- repo card のカスタマイズ
- Top languages
クイックヒント (カードを並べる)
通常、画像を並べてレイアウトすることはできません。画像を並べるには、以下のような方法があります。
<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>
自分の Vercel インスタンスにデプロイする
@codeSTACKr によるチュートリアルはこちら
GitHub API は 1 時間あたり 5k リクエストしか受け付けていないので、私の https://github-readme-stats.vercel.app/api がレートリミッターを超えてしまう可能性があります。自分の Vercel サーバーでホストしているのであれば、何も心配する必要はありません。デプロイボタンをクリックして始めましょう！
NOTE: #58 以降は 5k 以上のリクエストに対応できるようになり、ダウンタイムの問題もなくなりました 😄
Vercelの設定ガイド
- vercel.comに行きます。
Log inをクリックします。
Continue with GitHubを押して GitHub にサインインします。
- GitHub にサインインし、すべてのリポジトリへのアクセスを許可します。
- このリポジトリをフォークします。
- Vercel dashboardに戻ります。
Import Projectを選択します。
Import Git Repositoryを選択します。
- root を選択して、すべてをそのままにしておき、PAT_1 という名前の環境変数を（下図のように）追加します。これには個人アクセストークン (PAT) が含まれており、ここで簡単に作成することができます (すべてをそのままにしておいて、何かに名前を付けてください。)
- デプロイをクリックすれば完了です。API を使用するためにあなたのドメインを参照してください!
💖 このプロジェクトを支援する
私はできる限りのことをオープンソースで行い、また、このプロジェクトを利用する上で困っている皆さん全員に返信するようにしています。もちろん返信には時間が掛かる場合がありますが。
このプロジェクトは無料でご利用いただけます。
しかしながら、もしあなたがこのプロジェクトに満足しているのであれば、あるいはただ、私がソフトウェアを作り続けるよう励ましたいのであれば、いくつかの方法があります。
- あなたの readme で github-readme-stats を使用して適切なクレジットを付与し、それにリンクします 😄
- このプロジェクトにスターを贈り、他の人達にもシェアしてください 🚀
- PayPal を介して 1 回限りの寄付を行うことができます。私はおそらく コーヒーお茶を買うでしょう。 🍵
Thanks! ❤️
コントリビュートは大歓迎です！ 😍
このプロジェクトは ❤️ と JavaScript で作られています。