まず伝えたい内容を決める
README に何を書くかを決めてから、ウィジェット、統計、書き出し形式を調整しましょう。
プロフィール README のアイデアプロフィールカード作成
GitHub プロフィールカード生成ツール
最新の GitHub データでプロフィールカードを作れます。URL に一語追加してキャンバスを開き、README、ポートフォリオ、SNS 用に書き出しましょう。
02デザイン画面
GitHub で作っているものを伝えよう。
GitHubCard は公開 GitHub データを読み込み、プロフィールの情報をキャンバス上で自由に配置できます。
よく使われるウィジェット
- フォロワー、リポジトリ、Star 数の統計カード
- 連続貢献日数と活動グラフ
- 主な言語のカード、棒グラフ、ドーナツグラフ
- プロフィール、自己紹介、所在地、自由なテキスト
- 主なリポジトリと貢献ヒートマップ
デザイン画面
キャンバスエディター
バッジや URL パラメータを手作業で組み合わせず、キャンバス上でウィジェットを配置できます。
データウィジェット
20 種類以上のプロフィール情報
統計、連続貢献、言語、リポジトリ、活動、テキストを 1 枚にまとめます。
書き出し
SVG と PNG
README には鮮明な SVG を、ポートフォリオ、履歴書、SNS には固定 PNG を使えます。
03書き出しと埋め込み
README のためのカード。
GitHub README には更新される SVG を、固定画像が必要な場所には PNG を使えます。
GitHub README 用の SVG
SVG は高解像度画面でも鮮明で、Markdown、ドキュメント、ポートフォリオに使えます。
SNS プレビュー用の PNG
ブログの表紙、紹介記事、履歴書や、SVG が安定して表示されない場所には PNG を書き出せます。
04ガイド
ウィジェットを選ぶ前に、伝えたい内容を決めよう。
README の構成を考えるガイドや、統計バッジツールの比較をご覧ください。
プロフィール README ガイド
統計ツールを比較し、埋め込み用の Markdown を確認してからカードを作れます。
05使い方
GitHub URL からカードまで、3 ステップ。
ステップ 01
URL に card を追加
GitHub プロフィール URL の github の後に card を追加するか、ユーザー名を直接入力します。
ステップ 02
プロフィールの内容を選ぶ
活動、言語、リポジトリ、自由なメモから、自分を伝える情報を選びます。
ステップ 03
README 用に書き出す
カードを公開またはダウンロードして、README、ウェブサイト、ポートフォリオ、紹介記事に使います。
06よくある質問
プロフィールカードの質問
GitHub の統計カードやプロフィールカードには何を表示できますか？
統計、連続貢献日数、主な言語、プロフィール、リポジトリ、活動グラフ、自由なテキストなどを組み合わせられます。
プロフィールカードを GitHub README に埋め込めますか？
はい。デザインを書き出すか公開し、SVG のリンクを Markdown 画像として README、ポートフォリオ、ブログに追加できます。
カードは自動更新されますか？
標準カードの URL はキャッシュ付きの最新 GitHub データを使います。公開済みスナップショットのリンクは、表示を固定したい場合に適しています。
カード作成にログインは必要ですか？
標準カードはログインなしでプレビューできます。独自デザインの保存、公開、更新、管理には GitHub ログインが必要です。