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

プロフィール README について

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

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

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

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

必要な環境

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

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

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

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

ページの右上角でドロップダウンメニューを使い、New repository（新規リポジトリ）を選択してく� さい。
[Repository name] の下に、GitHub のユーザ名とマッチするリポジトリ名を入力します。たとえば、ユーザ名が「octocat」の� �合、リポジトリ名は「octocat」である必要があります。
必要な� �合、リポジトリの説明を追� します。たとえば、「個人リポジトリ」などです。
[Public] を選択します。
[Initialize this repository with a README] を選択します。
[Create repository] をクリックします。
右サイドバーの上にある [Edit 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について