跳至主要内容

创建 Gist

您可以创建两种类型的 gist:公开的和私密的。如果您准备与世界分享您的想法,请创建一个公开的 gist;如果您不准备分享,请创建一个私密的 gist。

关于 gist

Gist 提供了一种简单的方式与他人分享代码片段。每个 gist 都是一个 Git 仓库,这意味着它可以被 fork 和 clone。如果您在创建 gist 时登录了 GitHub,则 gist 将与您的帐户关联,并且您可以在导航到您的 gist 主页 时在您的 gist 列表中看到它。

Gist 可以是公开的或私密的。公开的 gist 会显示在 Discover 中,人们可以在创建新的 gist 时浏览它们。它们也是可搜索的,因此如果您希望其他人找到并查看您的作品,可以使用它们。

私密的 gist 不会显示在 Discover 中,并且除非您已登录并且是私密 gist 的作者,否则无法搜索。私密的 gist 不是私人的。如果您将私密 gist 的 URL 发送给朋友,他们将能够看到它。但是,如果您不认识的人发现了 URL,他们也将能够看到您的 gist。如果您需要将代码隐藏起来,您可能需要 创建一个私有仓库

创建 gist 后,您无法将其从公开转换为私密。但是,可以通过编辑 gist 并将可见性更新为公开来使私密 gist 成为公开的。

您将在以下情况下收到通知

  • 您是代码片段的作者。
  • 有人在代码片段中提及您。
  • 您可以通过点击任何代码片段顶部的**订阅**按钮来订阅代码片段。

您可以将代码片段固定到您的个人资料中,以便其他人可以轻松地看到它们。有关更多信息,请参阅“将项目固定到您的个人资料”。

您可以通过访问代码片段主页并点击**所有代码片段**来发现其他人创建的公共代码片段。这将带您到一个页面,该页面显示所有代码片段,并按创建或更新时间排序。您还可以使用代码片段搜索按语言搜索代码片段。

由于代码片段是 Git 仓库,您可以查看其完整的提交历史记录,包括差异。您还可以分叉或克隆代码片段。有关更多信息,请参阅“分叉和克隆代码片段”。

您可以通过点击代码片段顶部的**下载 ZIP**按钮来下载代码片段的 ZIP 文件。您可以在支持 JavaScript 的任何文本字段(例如博客文章)中嵌入代码片段。要获取嵌入代码,请点击代码片段的**嵌入** URL 旁边的剪贴板图标。要嵌入特定代码片段文件,请在**嵌入** URL 后附加?file=FILENAME

代码片段支持映射 GeoJSON 文件。这些地图显示在嵌入的代码片段中,因此您可以轻松地共享和嵌入地图。有关更多信息,请参阅“使用非代码文件”。

创建代码片段

请按照以下步骤创建代码片段。

您也可以使用 GitHub CLI 创建代码片段。有关更多信息,请参阅 GitHub CLI 文档中的“gh gist create”。

或者,您可以将桌面上的文本文件直接拖放到编辑器中。

  1. 登录 GitHub。

  2. 导航到您的代码片段主页.

  3. 可选地,在“Gist 描述”字段中,为您的 gist 输入描述。

  4. 在“包含扩展名的文件名”字段中,为您的 gist 输入文件名,包括文件扩展名。

  5. 在文件内容字段中,输入您的 gist 的文本。

  6. 可选地,要创建公开 gist,请点击 ,然后点击创建公开 gist

    Screenshot of the visibility dropdown menu for a new gist. Next to a button labeled "Create secret gist", a dropdown icon is outlined in dark orange.

  7. 点击创建私密 Gist创建公开 gist