跳到主要内容

在 Codespace 中处理 GitHub 文档

您可以使用 GitHub Codespaces 来处理 GitHub 文档。

关于 GitHub Codespaces

GitHub Codespaces 允许您在远离您机器的远程托管的开发环境中工作。您可以快速入门,无需设置工作环境或将文件下载到本地计算机。

更多信息,请参阅“GitHub Codespaces 概述”。

在 Codespace 中处理文档

以下步骤假设您已设置 GitHub Codespaces 以使用 Visual Studio Code for Web 编辑文件。如果您设置了其他编辑器,步骤非常相似。更多信息,请参阅“设置 GitHub Codespaces 的默认编辑器”。

  1. 导航到 GitHub 文档的开源存储库,github/docs

  2. 如果您是开源贡献者,请创建存储库的分支,然后按照您分支中的其余步骤操作。更多信息,请参阅“创建存储库分支”。

  3. 创建一个分支来处理。更多信息,请参阅“在存储库中创建和删除分支”。

  4. 在存储库的主页上,单击** 代码**,然后单击**在 BRANCH-NAME 上创建 Codespace**。

    将显示“设置您的 Codespace”页面。短暂时间后,将显示基于浏览器的 Visual Studio Code 版本。

  5. 使用资源管理器导航到要编辑的 Markdown 文件。如果文件是文章,它将位于 content 目录中。如果文件是可复用的内容,它将位于 data 目录中。

    在大多数情况下,content 目录中文章的路径与 URL 中的路径匹配,减去 .md 文件扩展名。例如,文章 https://docs.github.com/en/codespaces/getting-started/quickstart 的源代码是 Markdown 文件 content/codespaces/getting-started/quickstart.md

  6. 根据需要编辑 Markdown 文件。

  7. 保存您的更改。

  8. 提交并推送您的更改,可以使用源代码管理视图,或使用终端中的 Git 命令。更多信息,请参阅“关于 Git”。

创建拉取请求

  1. 导航到 github.com/github/docs/pulls 上的 github/docs 存储库的“拉取请求”选项卡。

  2. 单击**新建拉取请求**。

  3. 如果您是开源贡献者,请单击**跨分支比较**,然后选择您创建的分支存储库和您的工作分支。

    否则,将“比较”分支更改为您的工作分支。

  4. 检查显示的更改是否包含您在 Codespace 中所做的所有更改。如果它们没有,这可能表示您尚未将 Codespace 中的更改推送到 GitHub。

  5. 单击**创建拉取请求**。

  6. 输入拉取请求的详细信息,然后单击**创建拉取请求**。

    您的拉取请求将由 GitHub 文档团队成员审核。