GitHubプロフィールREADMEジェネレーター
GitHubのユーザー名と同じ名前のリポジトリを作ると、プロフィールページの上部に表示されるREADMEが得られます。このジェネレーターは、そのリポジトリ向けのきれいなMarkdownファイルを生成します:見出し、短い自己紹介、技術スタック、github-readme-statsで動く任意の統計カード。
プロフィールREADMEを作る方法
-
1
詳細を入力
表示名、キャッチコピー、所在地、取り組んでいることと学んでいること。
-
2
技術スタックを追加
カンマ区切りのリスト。各項目は太字のチップとして描画されます。
-
3
統計カードを有効化
GitHub StatsとTop Languagesのカードがgithub-readme-statsからライブで描画されます。アクティビティのオプションはコントリビューショングラフへのリンクを追加します。
-
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>、単純なインラインスタイル、を許可します。スクリプトとフォームはセキュリティのため除去されます。
いいえ。入力した値はプレビューを組み立てるためにサーバーへ送信され、マルチステップ表示では各ステップ間でページのリンクに含められます。データベースには何も保存されず、タブを閉じるとすべて破棄されます。
関連ツール
ASCII表リファレンス
0から127までの完全なASCII表です。NUL、LF、DELなどの制御コードを含め、各文字の10進数、16進数、8進数、2進数、HTML数値文字参照を表示します。
HTML文字参照
HTMLエンティティの検索可能なリスト、その名称コードおよび数値コード、および特殊文字や記号のワンクリックコピー機能を提供します。
キーボードショートカット一覧
macOS、Windows、Linux向けに、VS Code、Chrome、GNU Readlineを使うBashの公式資料に基づく既定ショートカットを検索できます。
EditorConfig ジェネレーター
インデントのスタイルとサイズ、改行コード、文字コード、空白ルールを指定して .editorconfig ファイルを生成し、IDE やエディタをまたいで書式を統一できます。
メールアドレス検証ツール
メールアドレスを検証します。RFC 5322構文チェック、MXレコードのライブ確認に加え、ローカル部、ドメイン、長さの詳細を表示します。メールは送信されません。
Markdownチートシート
見出し、リスト、表、コード、リンク、画像、GFM構文を、実際のプレビューとコピーできる例で確認できる実用的なMarkdownリファレンスです。
このツールは他の言語でも利用できます
- Gerador de README de Perfil do GitHub [PT]
- Công cụ tạo README hồ sơ GitHub [VI]
- مولّد ملف README للملف الشخصي على GitHub [AR]
- Generador de README de perfil de GitHub [ES]
- GitHub 프로필 README 생성기 [KO]
- Générateur de README de profil GitHub [FR]
- GitHub-profil-README-generator [SV]
- GitHub-Profil-README-Generator [DE]
- เครื่องมือสร้าง README โปรไฟล์ GitHub [TH]
- Generator README Profil GitHub [ID]
- GitHub-profiel-README-generator [NL]
- Generator README profilu GitHub [PL]
- GitHub Profile README Generator [EN]
- Generatore di README del profilo GitHub [IT]
- Генератор README профиля GitHub [RU]
- GitHub Profil README Oluşturucu [TR]
- GitHub 个人资料 README 生成器 [ZH]