GitHub Pages 快速入门

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

谁可以使用此功能?

GitHub Pages 可用于具有 GitHub Free 和适用于组织的 GitHub Free 的公共存储库,以及具有 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和私有存储库。有关更多信息,请参阅 GitHub 的计划

GitHub Pages 现在使用 GitHub Actions 来执行 Jekyll 构建。使用分支作为构建的源时,如果要使用内置的 Jekyll 工作流程,则必须在存储库中启用 GitHub Actions。或者,如果 GitHub Actions 不可用或已禁用,则将文件添加到源分支的根目录将绕过 Jekyll 构建过程并直接部署内容。有关启用 GitHub Actions 的更多信息,请参阅管理仓库的 GitHub Actions 设置.nojekyll

本文内容

  • 介绍
  • 创建您的网站
  • 更改标题和描述
  • 后续步骤

介绍

在本指南中,您将在 上创建一个用户站点。<username>.github.io

创建您的网站

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

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

  1. 输入 作为存储库名称。替换为您的 GitHub 用户名。例如,如果您的用户名是 ,则存储库名称应为 。username.github.io``username``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.

  1. 选择仓库可见性。有关更多信息,请参阅关于存储库

  2. 选择 Initialize this repository with a README。

  3. 单击 Create repository(创建存储库)。

  4. 在仓库名称下,单击设置.如果您看不到“设置”选项卡,请选择下拉菜单,然后单击 Settings(设置)。

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

  1. 在边栏的“Code and automation(代码和自动化)”部分中,单击页面.

  2. 在“Build and deployment(构建和部署)”下的“Source(源)”下,选择 Deploy from a branch(从分支部署)。

  3. 在“Build and deployment(构建和部署)”下的“Branch(分支)”下,使用分支下拉菜单并选择发布源。

    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.

  1. (可选)打开存储库的文件。该文件是您为站点编写内容的位置。您可以编辑文件或暂时保留默认内容。README.md``README.md

  2. 访问 查看您的新网站。请注意,将更改推送到 GitHub 后,最多可能需要 10 分钟才能发布对站点的更改。username.github.io

更改标题和描述

默认情况下,您网站的标题为 。您可以通过编辑仓库中的文件来更改标题。您还可以为站点添加描述。username.github.io``_config.yml

  1. 单击存储库的 Code (代码) 选项卡。

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

  3. 单击以编辑文件。

  4. 该文件已包含一行,用于指定站点的主题。添加一行新行,后跟所需的标题。添加一行新行,后跟所需的描述。例如:_config.yml``title:``description:

    1
    2
    3
    theme: jekyll-theme-minimal
    title: Octocat's homepage
    description: Bookmark this to keep an eye on my project updates!
  5. 编辑完文件后,单击 Commit changes(提交更改)。

后续步骤

您已经成功创建、个性化和发布了您的第一个 GitHub Pages 网站,但还有更多内容需要探索!以下是一些有用的资源,可帮助您使用 GitHub Pages 进行下一步作: