Skip to main content

GitHub Pages 快速入门

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

GitHub Pages 适用于具有 GitHub Free 和组织的 GitHub Free 的公共仓库,以及具有 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和私有仓库。 更多信息请参阅“GitHub 的产品”。

简介

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

本指南将引导您完成在 username.github.io 创建用户站点的过程。

创建网站

  1. 在任何页面的右上角,使用 下拉菜单选择 New repository(新建仓库)带有创建新仓库选项的下拉菜单

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

  3. 在仓库名称下,单击 Settings(设置)仓库设置按钮

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

  5. 单击 Choose a theme(选择主题)选择主题按钮

  6. 主题选择器将打开。 浏览可用的主题,然后单击 Select theme(选择主题)以选择主题。 以后更改主题很容易,因此,如果您不确定,请暂时选择一个。 主题选项和选择主题按钮

  7. 选择主题后,存储库的 README.md 文件将在文件编辑器中打开。 README.md 文件是您将为网站编写内容的位置。 您可以编辑文件或暂时保留默认内容。

  8. 编辑完文件后,单击 Commit changes(提交更改)

  9. 访问 username.github.io 以查看您的新网站。 注:对站点的更改在推送到 GitHub Enterprise Cloud 后,最长可能需要 20 分钟才会发布。

更改标题和说明

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

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

  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. 编辑完文件后,单击 Commit changes(提交更改)

后续步骤

有关如何向站点添加其他页面的详细信息,请参阅“使用 Jekyll 向 GitHub Pages 站点添加内容”。

有关使用 Jekyll 设置 GitHub Pages 站点的更多信息,请参阅“关于 GitHub Pages 和 Jekyll”。