管理您的个人资料自述文件

您可以向您的 GitHub 个人资料添加自述文件，以告诉其他人有关您自己的信息。

谁可以使用此功能？

托管用户帐户无法使用个人资料自述文件。

本文档中

关于您的个人资料自述文件

您可以通过创建个人资料自述文件与 GitHub 上的社区分享有关您自己的信息。GitHub 会在您的个人资料页面顶部显示您的个人资料自述文件。

您决定在个人资料自述文件中包含哪些信息，因此您可以完全控制在 GitHub 上如何展示自己。以下是一些示例，说明访客可能在您的个人资料自述文件中找到有趣、好玩或有用的信息。

  • 一个“关于我”部分，描述您的工作和兴趣
  • 您引以为豪的贡献以及这些贡献的相关背景
  • 在您参与的社区中获取帮助的指南

Screenshot of the profile page for @octocato. In the top-right corner, a profile README greets the viewer and lists information about the user's work.

您可以通过使用 GitHub Flavored Markdown 在个人资料自述文件中格式化文本并包含表情符号、图像和 GIF。有关更多信息，请参阅“GitHub 上的写作和格式设置入门”。有关自定义个人资料自述文件的实用指南，请参阅“GitHub 上的写作快速入门”。

先决条件

如果满足以下所有条件，GitHub 就会在您的个人资料页面上显示您的个人资料自述文件。

  • 您已创建了一个名称与您的 GitHub 用户名匹配的仓库。
  • 该仓库是公开的。
  • 该仓库在其根目录中包含一个名为 README.md 的文件。
  • README.md 文件包含任何内容。

注意

如果您在 2020 年 7 月之前创建了一个与您的用户名相同的公共仓库，GitHub 不会自动在您的个人资料上显示该仓库的 README。您可以通过转到 GitHub 上的仓库并点击**分享到个人资料**手动将仓库的 README 分享到您的个人资料。

添加个人资料 README

  1. 在任何页面的右上角，选择，然后点击**新建仓库**。

    Screenshot of a GitHub dropdown menu showing options to create new items. The menu item "New repository" is outlined in dark orange.

  2. 在“仓库名称”下，输入与您的 GitHub 用户名匹配的仓库名称。例如，如果您的用户名是“octocat”，则仓库名称必须为“octocat”。

  3. 可选地，在“描述”字段中，输入仓库的描述。例如，“我的个人仓库”。

  4. 选择**公开**。

  5. 选择**使用 README 初始化此仓库**。

  6. 点击**创建仓库**。

  7. 在右侧边栏上方，点击**编辑 README**。

生成的 README 文件预先填充了一个模板，为您提供一些个人资料 README 的灵感。

有关所有可用表情符号及其代码的摘要，请参阅“表情符号备忘单”。

删除个人资料 README

如果满足以下任何条件，个人资料 README 将从您的 GitHub 个人资料中删除

  • README 文件被删除或清空。
  • 仓库被设为私有。
  • 由于任一或两个名称的更改，仓库名称不再与您的用户名匹配。

您选择的方法取决于您的需求，但如果您不确定，我们建议您将仓库设为私有。有关如何将仓库设为私有的步骤，请参阅“设置仓库可见性”。

进一步阅读