GitHub README ビジュアルガイド

GitHub Profile Trophy: README 設定、テーマ、使いどころ

GitHub Profile Trophy はプロフィール README に達成感を加えられますが、主役ではなく小さな補助シグナルとして使うのが安全です。設定、テーマ、rank フィルター、配置、GitHub City との使い分けを整理します。

早わかり: GitHub Profile Trophy は README 用の小さな実績カード

GitHub Profile Trophy は GitHub ユーザー名から実績風カードを生成する仕組みです。プロフィール README に自己紹介、主要プロジェクト、連絡先がすでにある場合に、補助的な視覚シグナルとして役立ちます。

よい プロフィール README 構成 の代わりにはなりません。まず文章とプロジェクトで信頼を作り、その後に Trophy を添えます。

おすすめは控えめな使い方です。読みやすいテーマを選び、ユーザー名、列数、行数、表示する rank や title を調整します。巨大なカードを冒頭に置くより、活動セクション付近に小さく置くほうが自然です。

近い用途として、継続性は GitHub streak stats、README 内の 3D 画像は profile-3d-contrib、インタラクティブな 3D 都市は GitHub City が担当します。

トロフィー、プロジェクト、GitHub City の要素を含む README 解説グラフィック
トロフィーカードは README の物語を補助するもので、プロジェクト証拠の代わりではありません。

README をうるさくせずに GitHub Profile Trophy を追加する方法

設定自体は簡単ですが、編集上の判断が重要です。アイコンや rank は目立つため、活動の理解に役立つ場所へ置きます。

追加前にデスクトップとモバイルで README を確認します。最初の画面が badge や widget で埋まっているなら、追加より先に整理します。

1

README の目的を決める

採用、OSS 支援、学習記録、ポートフォリオのどれを重視するか決めます。

2

公式リポジトリから始める

管理されているリポジトリやホスト URL を使い、username を正しく指定します。

3

落ち着いたテーマを選ぶ

GitHub のライト/ダーク両方で読みやすい配色にします。

4

行数・列数・rank を絞る

小さいカードほど読みやすく、弱いシグナルを目立たせずに済みます。

5

活動文脈の近くに置く

何を示すカードか一文で説明し、プロジェクトや GitHub City へつなげます。

GitHub Profile Trophy と Streak Stats、Readme Stats、GitHub City の違い

これらの widget は答える質問が違います。訪問者が数秒で何を知るべきかで選びます。

全部を上部に積む必要はありません。強いプロジェクトリンクと小さなカードのほうが伝わります。

選択肢 向いている用途 設定 リスク 最適な配置
GitHub Profile Trophy 公開実績や活動の節目を示す。 ホスト URL のパラメータを設定。 プロジェクト証拠がないと飾りに見える。 イントロ下か活動セクション付近。
GitHub Streak Stats 継続的な貢献リズム。 streak カード画像を追加。 生産性全体と誤解されやすい。 データ制限の説明と一緒に使う。
GitHub Readme Stats 言語、リポジトリ、プロフィール要約。 カード種別、ユーザー、テーマを選ぶ。 増やしすぎると重くなる。 プロジェクト説明を補強する時。
GitHub City 3D 貢献パターンの探索。 ツールを開いてユーザー名を入力。 小さな README カードではない。 詳細探索へのリンクとして使う。
目的、テーマ、フィルター、配置を選ぶ流れ
安全な流れはプロフィール目的から始まり、テーマ、フィルター、配置を絞ります。

Trophy カードが正しく見えない時の確認

多くはパラメータ、キャッシュ、元データへの期待値が原因です。

トロフィーがない場合も、サービスの不具合とは限りません。公開シグナルがまだ存在しない、またはキャッシュ中のことがあります。

カードが空白

ユーザー名、URL エンコード、通信、GitHub 側の画像取得を確認します。

横幅が大きすぎる

列数、行数、表示サイズを減らし、モバイルで確認します。

色が合わない

落ち着いたテーマに変え、badge の色数も減らします。

誤解を招く trophy

非表示にするか文脈を添え、実績を過大に見せないようにします。

強いプロフィール README での Trophy の置き場所

冒頭要約の後、または活動セクション付近に置くのが自然です。主要プロジェクトを押し下げない位置にします。

強いプロフィールは文章、実プロジェクト、1 つの視覚レイヤーで構成されます。すでに stats widget が多いなら、さらに画像を増やすより GitHub City へのリンクがよい場合があります。

内部リンクも目的別に使います。構成は README テンプレート、データ規則は contribution graph、探索は GitHub City です。

実用ルール

Trophy が次のプロジェクトを信頼しやすくしないなら、下へ移すか削除します。

FAQ

GitHub Profile Trophy とは?

GitHub ユーザー名向けの実績風トロフィーカードで、主にプロフィール README に埋め込みます。

README.md にどう追加する?

管理されているプロジェクトの URL に username、theme、表示オプションを指定し、Markdown 画像または HTML img で埋め込みます。

GitHub Readme Stats と同じ?

違います。Trophy は実績風 badge、Readme Stats は言語やリポジトリなどの統計カードです。

プロフィール上部に置くべき?

通常はいいえ。自己紹介と主要プロジェクトの後に補助として置くのが安全です。

GitHub City と併用できる?

できます。Trophy は小さなシグナル、GitHub City はより豊かな 3D 探索として使えます。

参考リンク