GitHubプロフィールREADMEジェネレーター

結果

GitHubのユーザー名と同じ名前のリポジトリを作ると、プロフィールページの上部に表示されるREADMEが得られます。このジェネレーターは、そのリポジトリ向けのきれいなMarkdownファイルを生成します:見出し、短い自己紹介、技術スタック、github-readme-statsで動く任意の統計カード。

プロフィールREADMEを作る方法

  1. 1

    詳細を入力

    表示名、キャッチコピー、所在地、取り組んでいることと学んでいること。

  2. 2

    技術スタックを追加

    カンマ区切りのリスト。各項目は太字のチップとして描画されます。

  3. 3

    統計カードを有効化

    GitHub StatsとTop Languagesのカードがgithub-readme-statsからライブで描画されます。アクティビティのオプションはコントリビューショングラフへのリンクを追加します。

  4. 4

    Markdownをコピー

    ユーザー名にちなんだリポジトリを作り、ルートにREADME.mdをプッシュします。

「特別なリポジトリ」の仕組み

ユーザー名がalexで、alexという名前の公開リポジトリを作ると、GitHubはそのリポジトリのREADME.mdをプロフィール(Popular repositoriesの上)に描画します。これはハックではなく、文書化された機能です。

ジェネレーターが埋め込めるカード

カード ソースURL 備考
GitHub統計 github-readme-stats-one-bice.vercel.app/api?username=...&show_icons=true コミット、PR、issue
主要言語 github-readme-stats-one-bice.vercel.app/api/top-langs/?username=... リポジトリのサイズによる言語の内訳
コントリビューションアクティビティ github.com/{username}?tab=overview 「Streak」をオンにすると表示されるリンク

2つの統計カードはPNGのエンドポイントで、誰かが未認証であなたのプロフィールを読み込むときを含め、どのMarkdownビューアーでも描画されます。アクティビティのリンクはGitHubのコントリビューショングラフを開きます。

読みやすいコンテンツ

  • 1行のキャッチコピー:役割+焦点(「Rustのインフラエンジニア、トレーシングに関心」)。
  • スタックの上には最大で3〜5個の箇条書き。それ以上は履歴書のダンプに見えます。
  • 段落ではなく、チップとしてのスキル。読み手は技術をざっと探します。
  • 実際にメンテしているプロジェクトへのリンク。プロフィールにピン留めした放置リポジトリは、ないより悪いです。
  • 連絡先の行:メールまたは1つのソーシャルのハンドル。6つのネットワークを並べないでください。

そこに置くべきでないもの

  • 私的な住所や電話番号。
  • リクルーター向けの文言(「Open to work」はLinkedInやGitHubのバナーのオプションに属します)。
  • すべての行に絵文字、1つか2つは問題ありませんが、ジャングルはノイズです。

よくある質問

github-readme-statsはVercelでホストされており、時折レート制限がかかったり、古いデータをキャッシュしたりします。カードが壊れたら数分待つか、プロジェクトをセルフホストしてください、リポジトリにワンクリックのVercelデプロイボタンがあります。

repoスコープを持つトークンでサービスを認証した場合のみです。既定では統計は公開コミットのみを数えますが、公開プロフィールでは通常それが正しい選択です。

はい。GitHubはMarkdown内でHTMLの一部、<img><details><sub><sup>、単純なインラインスタイル、を許可します。スクリプトとフォームはセキュリティのため除去されます。

いいえ。入力した値はプレビューを組み立てるためにサーバーへ送信され、マルチステップ表示では各ステップ間でページのリンクに含められます。データベースには何も保存されず、タブを閉じるとすべて破棄されます。

関連ツール

このツールは他の言語でも利用できます