Skip to main content

このバージョンの GitHub Enterprise はこの日付をもって終了となりました: 2023-01-18. 重大なセキュリティの問題に対してであっても、パッチリリースは作成されません。 パフォーマンスの向上、セキュリティの向上、新機能の向上を図るために、最新バージョンの GitHub Enterprise にアップグレードします。 アップグレードに関するヘルプについては、GitHub Enterprise サポートにお問い合わせく� さい

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

GitHub プロフィールに README を追� して、他のユーザに自分の情� �を伝えることができます。

プロフィール README について

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

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

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

プロフィールに表示されるプロフィール README ファイル

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

前提条件

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

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

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

README をプロフィールに共有するためのボタン

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

  1. ページの右上隅で、[] ドロップダウン メニューを使用して、 [新しいリポジトリ] を選択します。 新しいリポジトリを作成するオプションがあるドロップダウン

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

  3. 必要に応じて、リポジトリの説明を追� します。 たとえば、「個人リポジトリ」などです。 リポジトリの説明を入力するフィールド

  4. [パブリック] を選択します。 可視性を選択するためのオプション ボタン ([パブリック] が選択された状態) 1. [Initialize this repository with a README] (このレポジトリを README で初期化する) を選択します。 [このリポジトリを README で初期化する] チェックボックス 1. [Create repository] (リポジトリの作成) をクリックします。 リポジトリを作成するボタン

  5. 右側のサイドバーの上にある [README の編集] をクリックします。 README ファイルを編集するためのボタン

    生成された 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. リポジトリをプライベートにする方法については、「リポジトリの可視性を変更する」を参照してく� さい。

参考資料