GitHub Pages 快速入门

您可以使用 GitHub Pages 来展示一些开源项目、主持博客甚或分享您的简历。 本指南将帮助您开始创建下一个网站。

谁可以使用此功能？

GitHub Pages 适用于具有 GitHub Free 和组织的 GitHub Free 的公共存储库，以及具有 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和专用存储库。 有关详细信息，请参阅“GitHub 的计划”。

从 2024 年 6 月 30 日起，所有 GitHub Pages 版本都将使用 GitHub Actions。 无需进行其他更改，但必须在存储库中启用 GitHub Actions 才能继续构建。 有关 GitHub Actions 运行器的详细信息，请参阅“管理存储库的 GitHub Actions 设置”。

本文内容

简介

GitHub Pages 是通过 GitHub Enterprise Cloud 托管和发布的公共网页。 启动和运行的最快方法是使用 Jekyll 主题选择器加载预置主题。 然后，您可以修改 GitHub Pages 的内容和样式。

本指南将引导你在 username.github.io 创建用户站点。

创建网站

  1. 在任何页面的右上角，选择 ，然后单击“新建存储库”****。

    GitHub 下拉菜单的屏幕截图，其中显示了用于创建新项的选项。 菜单项“新建存储库”用深橙色框标出。

  2. 输入 username.github.io 作为存储库名称。 将 username 替换为你的 GitHub 用户名。 例如，如果用户名为 octocat，则存储库名称应为 octocat.github.io。 存储库中 GitHub Pages 设置的屏幕截图。 存储库名称字段包含文本“octocat.github.io”，并用深橙色框出。

  3. 在存储库名称下，单击 “设置”。 如果看不到“设置”选项卡，请选择“”下拉菜单，然后单击“设置”********。

    存储库标头的屏幕截图，其中显示了选项卡。 “设置”选项卡以深橙色边框突出显示。

  4. 在边栏的“代码和自动化”部分中，单击“ Pages”。

  5. 在“生成和部署”的“源”下，选择“从分支进行部署”。

  6. 在“生成和部署”的“分支”下，使用分支下拉菜单并选择发布源。 GitHub 存储库中 Pages 设置的屏幕截图。 用于为发布源选择分支的菜单（标有“无”）用深橙色框出。

  7. （可选）打开存储库的 README.md 文件。 README.md 文件是你将为站点编写内容的位置。 您可以编辑文件或暂时保留默认内容。

  8. 访问 username.github.io 以查看新网站。 请注意，对站点的更改在推送到 GitHub Enterprise Cloud 后，最长可能需要 10 分钟才会发布。

更改标题和说明

默认情况下，站点的标题为 username.github.io。 可通过编辑存储库中的 _config.yml 文件来更改标题。 您还可以为您的网站添加说明。

  1. 单击存储库的“代码”选项卡。

  2. 在文件列表中，单击 _config.yml 以打开该文件。

  3. 单击 编辑文件。

  4. _config.yml 文件已包含指定站点主题的行。 添加一个新行，其中 title: 后跟所需的标题。 添加一个新行，其中 description: 后跟所需的描述。 例如：

    theme: jekyll-theme-minimal
title: Octocat's homepage
description: Bookmark this to keep an eye on my project updates!

  5. 编辑完文件后，单击“提交更改”。

后续步骤

若要详细了解如何向网站添加其他页面，请参阅“使用 Jekyll 向 GitHub Pages 站点添加内容”。

若要详细了解如何使用 Jekyll 设置 GitHub Pages 站点，请参阅“关于 GitHub 页面和 Jekyll”。