16 KiB
GitHub Readme Stats
あなたのREADMEに動的に生成されたGitHubの統計情報を載せましょう！
View Demo · Report Bug · Request Feature
このプロジェクトを気に入っていただけましたか？
もしよろしければ、プロジェクトのさらなる改善のために寄付を検討して頂けると嬉しいです！
Features
GitHub Stats Card
以下の構文をコピーして、あなたの Markdown ファイルに貼り付けるだけです。 簡単ですね！
?username= の値は、あなたの GitHub アカウントのユーザー名に変更してください。
[](https://github.com/anuraghazra/github-readme-stats)
Note: カードに表示されるランクはユーザの統計情報に基づいて計算されています。詳しくは、src/calculateRank.jsを見てください。
Hiding individual stats
クエリパラメータ ?hide= にカンマ区切りの値を渡すことで、特定の統計情報を隠すことができます。
Options:
&hide=stars,commits,prs,issues,contribs
Adding private contributions count to total commits count
クエリパラメータ ?count_private=true を使用することで、private contributions の数をコミット総数に追加することができます。
Note: このプロジェクトを自分でデプロイしている場合、デフォルトでは非公開の貢献がカウントされます。
Options:
&count_private=true
Showing icons
クエリパラメータ ?show_icons=true を使用することで、アイコンが表示が有効になります。
Themes
内蔵されているテーマを使用することで、任意の手動のカスタマイズを行うことなく、カードの外観をカスタマイズすることができます。
?theme=THEME_NAME は以下のように使います。
All inbuilt themes :-
dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula
用意されている全てのテーマのプレビューや設定ファイルを見ることができます。もしよろしければ、新しいテーマを投稿してみてください (´∀` )
Customization
Stats Card や Repo Card の外観を URL パラメーターを使って好きなようにカスタマイズすることができます。
Customization Options:
| 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 | 項目の非表示 | undefined | N/A | undefined |
| hide_rank | boolean | ranking の非表示 | false | N/A | N/A |
| hide_title | boolean | タイトルの非表示 | false | N/A | false |
| hide_border | boolean | 枠線の非表示 | false | N/A | N/A |
| show_owner | boolean | オーナー名の表示 | 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 | private contributions 数をコミット総数に追加 | false | N/A | N/A |
| layout | string | レイアウトのオプション選択 | N/A | N/A | 'default' |
キャッシュに関する注意点: Repo cards のデフォルトのキャッシュは、フォーク数とスター数が 1k 未満の場合は 30 分(1800 秒) で、それ以外の場合は 2 時間(7200) です。また、キャッシュは最低でも 30 分、最大でも 24 時間に制限されていることに注意してください。
GitHub Extra Pins
GitHub extra pins を使うと、GitHub の readme プロフィールを使って、自分のプロフィールに 6 つ以上のリポジトリをピン留めすることができます。
イェーイ! もはや 6 つのピン留めされたリポジトリに制限されることはありません。
Usage
以下のコードをあなたの readme にコピー & ペーストし、リンクを変更してください。
Endpoint: api/pin?username=anuraghazra&repo=github-readme-stats
[](https://github.com/anuraghazra/github-readme-stats)
Demo
リポジトリのオーナーのユーザー名を含める場合は、show_owner 変数を使用します。
Top Languages Card
Top languages card には、その GitHub ユーザーが最も利用している Top languages が表示されます。
NOTE: Top languages は、ユーザのスキルレベルを示すものではなく、GitHub 上でどの言語で最も多くのコードを書いているかを示す GitHub の指標です。
Usage
以下のコードをあなたの readme にコピー & ペーストし、リンクを変更してください。
Endpoint: api/top-langs?username=anuraghazra
[](https://github.com/anuraghazra/github-readme-stats)
Hide individual languages
クエリパラメータ ?hide=language1,language2 使用することで、個々の言語を非表示にすることができます。
[](https://github.com/anuraghazra/github-readme-stats)
Compact Language Card Layout
クエリパラメータ &layout=compact を使用することで、カードのデザインを変更することができます。
[](https://github.com/anuraghazra/github-readme-stats)
Demo
- Compact layout
All Demos
- Default
- Hiding specific stats
- Showing icons
- Themes
任意のテーマを選択できます。
- Customizing stats card
- Customizing repo card
- Top languages
Quick Tip (Align The Repo Cards)
通常、画像を並べてレイアウトすることはできません。そのためには、次のような方法があります。
<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>
Deploy on your own Vercel instance
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 を使用するためにあなたのドメインを参照してください!
💖 Support the project
私はできる限りのことをオープンソースで行い、これらのプロジェクトを利用して支援を必要としている皆さんに返信するようにしています。もちろんです。 これは時間がかかります。無料でご利用いただけます。
しかし、もしあなたがこのプロジェクトを使っていて、それに満足しているのであれば、あるいは単に私にものを作り続けることを奨励したいのであれば、いくつかの方法があります。
- あなたの readme で github-readme-stats を使用して適切なクレジットを付与し、それにリンクします (´∀` )
- 主演とプロジェクトの共有 🚀
- PayPal を介して 1 回限りの寄付を行うことができます。私はおそらく コーヒーお茶買うでしょう。 🍵
Thanks! ❤️
Contributions を歓迎します！ <3
このプロジェクトは ❤️ と JavaScript で作られています。