GitHub Profile READMEとは

GitHubのプロフィールページ（github.com/ユーザー名）にカスタムREADMEを表示できる機能。 自己紹介、技術スタック、リポジトリの紹介などを自由にMarkdownで書ける。

作成手順

1. 自分のユーザー名と同名のリポジトリを作成

リポジトリ名: <ユーザー名>/<ユーザー名>

例: rengotaku/rengotaku

  • Public で作成すること（Privateだと表示されない）

2. README.mdを配置

リポジトリのルートに README.md を作成する。

3. 表示条件

以下の全てを満たすと、プロフィールページにREADMEが表示される:

  • リポジトリ名がユーザー名と完全一致
  • リポジトリがPublic
  • ルートに README.md が存在
  • README.md にコンテンツがある

4. 確認

リポジトリページの右側に以下のメッセージが表示されていればOK:

rengotaku/rengotaku is now a special repository. You can display README.md from this repository on your public GitHub profile.

README.mdの例

# 👋 ユーザー名

Webエンジニア / 日本

## 🛠 技術スタック

**メイン**: Go / Ruby / TypeScript
**インフラ**: AWS / Docker / Terraform

## 📝 ブログ

👉 [example.github.io](https://example.github.io/)

## 🔧 つくったもの

| リポジトリ | 概要 |
|-----------|------|
| [repo-name](https://github.com/user/repo) | 説明 |

参考