跳至主要内容

GitHub Pages 快速入门

你可以使用 GitHub Pages 展示一些开源项目、托管博客,甚至分享你的简历。本指南将帮助你开始创建你的下一个网站。

谁可以使用此功能?

GitHub Pages 可用于具有 GitHub 免费版和 GitHub 免费版(适用于组织)的公共存储库,以及具有 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 托管和发布的公共网页。启动并运行的最快方法是使用 Jekyll 主题选择器加载预制主题。然后,你可以修改 GitHub Pages 的内容和样式。

本指南将指导你创建 username.github.io 上的用户网站。

创建网站

  1. 在任何页面的右上角,选择 ,然后单击新建存储库

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

  2. 输入username.github.io作为存储库名称。将username替换为你的 GitHub 用户名。例如,如果你的用户名是octocat,则存储库名称应为octocat.github.io

    Screenshot of GitHub Pages settings in a repository. The repository name field contains the text "octocat.github.io" and is outlined in dark orange.

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

    Screenshot of a repository header showing the tabs. The "Settings" tab is highlighted by a dark orange outline.

  4. 在侧边栏的“代码和自动化”部分,单击 页面

  5. 在“构建和部署”下的“源”下,选择从分支部署

  6. 在“构建和部署”下的“分支”下,使用分支下拉菜单并选择发布源。

    Screenshot of Pages settings in a GitHub repository. A menu to select a branch for a publishing source, labeled "None," is outlined in dark orange.

  7. (可选)打开存储库的README.md文件。README.md文件是你编写网站内容的地方。你可以编辑文件或暂时保留默认内容。

  8. 访问username.github.io以查看你的新网站。请注意,在将更改推送到 GitHub 后,你的网站可能需要长达 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 Pages 和 Jekyll”。