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

プロフィール README について

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

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

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

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

必要な環境

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

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

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

1. ページの右上角で ドロップダウンメニューを使い、New repository（新規リポジトリ）を選択してください。

2. [Repository name] の下に、GitHub のユーザ名とマッチするリポジトリ名を入力します。 たとえば、ユーザ名が「octocat」の場合、リポジトリ名は「octocat」である必要があります。

3. 必要な場合、リポジトリの説明を追加します。 たとえば、「個人リポジトリ」などです。

4. [Public] を選択します。

5. [Initialize this repository with a README] を選択します。

6. [Create repository] をクリックします。

7. 右サイドバーの上にある [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について