Skip to main content

Creating a GitHub Pages site

You can create a GitHub Pages site in a new or existing repository.

GitHub Pages 适用于具有 GitHub Free 和组织的 GitHub Free 的公共仓库,以及具有 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和私有仓库。

注意: 组织所有者可以限制从组织拥有的存储库发布 GitHub Pages 站点。 有关详细信息,请参阅“管理 GitHub Pages 站点的发布”。

Creating a repository for your site

可以为站点创建存储库或选择现有存储库。

如果存储库中并非所有文件都与站点相关,且要为存储库创建 GitHub Pages 站点,则能够为站点配置发布源。 例如,可以使用专用分支和文件夹保存站点源文件。

如果要在现有存储库中创建站点,请跳至“创建站点”一节。

  1. 在任何页面的右上角,使用 下拉菜单选择“新建存储库”。 包含创建新存储库选项的下拉菜单
  2. 使用“所有者”下拉菜单选择你想要拥有存储库的帐户。 “所有者”下拉菜单
  3. 输入仓库的名称和说明(可选)。 如果要创建用户或组织站点,则存储库必须命名为 <user>.github.io<organization>.github.io。 如果您的用户或组织名称包含大写字母,您必须小写字母。 有关详细信息,请参阅“关于 GitHub Pages”。 创建存储库字段
  4. 选择仓库可见性。 有关详细信息,请参阅“关于存储库”。 用于选择存储库可见性的单选按钮
  5. 选择“使用 README 初始化此存储库”。 “使用自述文件初始化此存储库”复选框
  6. 单击“创建存储库”。 创建存储库的按钮

Creating your site

必须先在 GitHub Enterprise Server 上有站点的仓库,然后才可创建站点。 如果未在现有存储库中创建站点,请参阅“为站点创建存储库”。

警告:如果你的站点管理员启用了公共页面,GitHub Pages 站点将在 Internet 上公开,即使该站点的存储库是私有的或内部的也是如此。 如果站点的存储库中有敏感数据,你可能想要在发布前删除数据。 有关详细信息,请参阅“为企业配置 GitHub Pages”和“关于存储库”。

  1. 在 GitHub Enterprise Server 上,导航到站点的仓库。

  2. 确定要使用的发布源。 有关详细信息,请参阅“为 GitHub Pages 站点配置发布源”。

  3. Create the entry file for your site. GitHub Pages will look for an index.html, index.md, or README.md file as the entry file for your site.

    The entry file must be at the top level of your chosen publishing source. For example, if your publishing source is the /docs folder on the main branch, your entry file must be located in the /docs folder on a branch called main.

  4. 配置发布源。 有关详细信息,请参阅“为 GitHub Pages 站点配置发布源”。

  5. 在存储库名称下,单击 “设置”。 “存储库设置”按钮

  6. In the left sidebar, click Pages. Page tab in the left-hand sidebar

  7. 要查看您已发布的站点,请在“GitHub Pages”下点击您的站点 URL。 已发布站点的 URL

    注意: 对站点的更改在推送到 GitHub Enterprise Server 后,最长可能需要 10 分钟才会发布。 如果一小时后仍然在浏览器中看不到 GitHub Pages 站点更改,请参阅“关于 GitHub Pages 站点的 Jekyll 生成错误”。

注意:If站点尚未自动发布,请确保具有管理员权限和经验证的电子邮件地址的人员已将站点推送到发布源。

Next steps

You can add more pages to your site by creating more new files. Each file will be available on your site in the same directory structure as your publishing source. For example, if the publishing source for your project site is the gh-pages branch, and you create a new file called /about/contact-us.md on the gh-pages branch, the file will be available at http(s)://<hostname>/pages/<username>/<repository>/about/contact-us.html.

You can also add a theme to customize your site’s look and feel. For more information, see "Adding a theme to your GitHub Pages site using Jekyll".

To customize your site even more, you can use Jekyll, a static site generator with built-in support for GitHub Pages. For more information, see "About GitHub Pages and Jekyll".

Further reading