プロフィールの README を管理する

プロフィール README について

プロフィール README を作成すると、で自分に関する情� �をコミュニティと共有できます。 GitHub では、プロフィールページの上部にプロフィール README が表示されます。

プロフィール README に含める情� �を決めることができるため、GitHub で自分に関するどのような情� �を表示するかを完全に制御できます。アクセスしたユーザがあなたのプロフィール README を見て、興味深い、楽しい、役立つと感じる可能性のある情� �の例は次のとおりです。

あなたの仕事や興味について説明した「自己紹介」セクション
あなたが誇りに思っているコントリビューションとそれらのコントリビューションについてのコンテキスト
あなたが関連しているコミュニティでサポートを得るためのガイド

GitHub Flavored Markdown を使用して、テキストをフォーマットし、絵文字、画像、GIF をプロフィール README に含めることができます。詳細については、「GitHub での書き込みと書式設定の概要」を参照してく� さい。

前提条件

次のすべてが当てはまる� �合、GitHubはプロフィールページにプロフィール README を表示します。

GitHub ユーザ名にマッチする名前のリポジトリを作成した。
リポジトリがパブリックである。
リポジトリのルートに README.md という名前のファイルが含まれている。
README.md ファイルに任意のコンテンツが含まれている。

注: 2020 年 7 月以前にユーザー名と同名のパブリックリポジトリを作成していた� �合、GitHub のプロフィールにはリポジトリの README が自動的に表示されません。 GitHub.com のリポジトリに移動して、 [プロフィールで共有] をクリックすると、リポジトリの README をプロフィールで手動で共有できます。

プロフィールの README を追� する

ページの右上隅で、[] ドロップダウンメニューを使用して、 [新しいリポジトリ] を選択します。
[Repository name] の下に、GitHub のユーザ名とマッチするリポジトリ名を入力します。たとえば、ユーザ名が「octocat」の� �合、リポジトリ名は「octocat」である必要があります。
必要に応じて、リポジトリの説明を追� します。たとえば、「個人リポジトリ」などです。
[パブリック] を選択します。 1. [Initialize this repository with a README] (このレポジトリを README で初期化する) を選択します。 1. [Create repository] (リポジトリの作成) をクリックします。
右側のサイドバーの上にある [README の編集] をクリックします。

生成された README ファイルには、プロフィール README のアイディアを得るためのテンプレートが事前入力されています。

使用できるすべての絵文字とそのコードの概要については、絵文字のチートシートを参照してく� さい。

プロフィール README を削除する

次のいずれかに該当する� �合、プロフィール README は GitHub のプロフィールから削除されます。

README ファイルが空であるか、存在しない。
リポジトリがプライベートである。
リポジトリ名がユーザ名とマッチしなくなった。

The method you choose is dependant upon your needs, but if you're unsure, we recommend making your repository private. リポジトリをプライベートにする方法については、「リポジトリの可視性を変更する」を参照してく� さい。

参考資料

README について