促进 Codespaces 的快速创建和恢复

您可以添加一个链接，将用户直接带到创建 Codespace 的页面，并预先配置您选择的选项。或者，您可以链接到“恢复 Codespace”页面。

本文档

概述

您可以通过提供指向代码空间创建页面的链接，使人们更容易在代码空间中处理您的仓库。您可能希望在仓库的 README 文件中执行此操作。例如，您可以将链接添加到“在 GitHub 代码空间中打开”徽章中。

Screenshot of an "Open in GitHub Codespaces" badge on a README page.

指向代码空间创建页面的链接可以包含特定的配置选项，以帮助人们创建合适的代码空间。使用该链接的人员可以在创建代码空间之前选择不同的选项（如果需要）。有关可用选项的信息，请参阅“为仓库创建代码空间”。

或者，您可以链接到“恢复代码空间”页面，该页面为人们提供了一种快速方法来打开他们最近正在使用的代码空间。

创建指向仓库的代码空间创建页面的链接

您可以使用以下 URL 来链接到仓库的代码空间创建页面。将大写字母中的文本替换掉。

  • 为仓库的默认分支创建代码空间：https://codespaces.new/OWNER/REPO-NAME
  • 为仓库的特定分支创建代码空间：https://codespaces.new/OWNER/REPO-NAME/tree/BRANCH-NAME
  • 为拉取请求的主题分支创建代码空间：https://codespaces.new/OWNER/REPO-NAME/pull/PR-SHA

配置更多选项

您可以使用“共享深度链接”选项来配置代码空间的更多选项并构建自定义 URL，然后复制“在 GitHub 代码空间中打开”徽章的 Markdown 或 HTML 代码段。

  1. 在 GitHub.com 上，导航到仓库的主页。

  2. 如果您要为除仓库默认分支以外的分支创建链接，请在仓库名称下方单击标有当前分支名称的按钮。在下拉菜单中，选择要为其创建链接的分支。

    Screenshot of the expanded branch dropdown menu, listing various branches. The dropdown menu, labeled with a branch icon and "trunk," is highlighted with a dark orange outline.

  3. 点击 ** 代码** 按钮，然后点击 **Codespaces** 选项卡。

  4. 要打开“共享 codespace 配置”窗口，请在 **Codespaces** 选项卡的右上角选择 ，然后点击 **共享深层链接**。

    Screenshot of the options dropdown in the "Codespaces" tab. The "Share a deep link" option is highlighted with an orange outline.

  5. 可选地，要将用户带到一个页面，让他们可以快速恢复最近的 codespace 或创建一个新的 codespace，请选择 **快速入门**。有关更多信息，请参阅“创建恢复 codespace 的链接”。

  6. 可选地，要指定一个开发容器配置，请选择 **配置文件**，然后使用下拉菜单选择一个配置。如果您没有指定配置，将使用您的存储库的默认配置。有关更多信息，请参阅“开发容器简介”。

  7. 在“代码段”下，您可以复制您构建的 URL，或复制包含“在 GitHub Codespaces 中打开”徽章的 Markdown 或 HTML 代码段。要复制 URL 或代码段，请在 **URL**、**HTML** 和 **Markdown** 选项卡之间选择，然后点击 .

    Screenshot of the "Share codespace configuration" window. Next to the "new codespace" URL, an icon of two overlapping squares is outlined in orange.

您可以创建一个链接到一个页面，用于恢复与 URL 中指定的存储库、分支和其他选项匹配的最新 codespace。

将 ?quickstart=1 添加到 codespaces.new URL，例如本文前面部分列出的 URL。这将生成一个显示“恢复 codespace”页面的 URL。

例如，URL https://codespaces.new/octo-org/octo-repo?quickstart=1 将打开一个页面，允许您恢复 octo-org/octo-repo 存储库的默认分支的最新 codespace。

Screenshot of the "Resume codespace" page showing the "Resume this codespace" and "Create a new one" buttons.

注意:

  • 如果 codespaces.new URL 已经包含查询字符串，请在查询字符串的末尾添加 &quickstart=1。
  • 这种类型的 URL 将始终在 VS Code 网页客户端中打开代码空间，即使您未将其设置为 GitHub Codespaces 的默认编辑器。

如果未找到匹配的代码空间，则页面标题为“创建代码空间”，并显示一个按钮，用于使用匹配的参数创建新的代码空间。

这种类型的 URL 非常有用，例如，在您的存储库的 README 中，因为它可以让用户只需点击几下即可创建代码空间或恢复其代码空间。

创建“在 GitHub Codespaces 中打开”徽章

提示：您可以使用“共享深度链接”选项创建包含“在 GitHub Codespaces 中打开”徽章的 Markdown 或 HTML 代码段，该徽章具有自定义 URL。有关更多信息，请参阅“配置更多选项”。

  1. 获取代码空间创建页面或“恢复代码空间”页面的 URL，如上一节所述。

  2. 将以下 Markdown 添加到您的存储库的 README.md 文件中，例如

    Markdown
    [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](URL)

    例如

    [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/github/docs)

    示例 Markdown 呈现如下

    Open in GitHub Codespaces.