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 Pages 站点的发布”。

为站点创建仓库

如果站点是一个独立的项目,您可以创建新仓库来存储站点源代码。 如果站点与现有项目相关联,则可以在默认分支或其他分支上 /docs 文件夹中将源代码添加到该项目的存储库。 例如,如果您创建站点来发布已经在 GitHub Enterprise Cloud 上的项目文档, 您可能想要将站点的源代码存储在与项目相同的仓库中。

如果拥有仓库的帐户使用组织的 GitHub Free 或 GitHub Free,仓库必须是公共的。

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

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

  2. 使用 Owner(所有者)下拉菜单选择你想要拥有仓库的帐户。 所有者下拉菜单

    Note: If you're a 托管用户, you can only publish GitHub Pages sites from repositories owned by organizations. 更多信息请参阅“关于 GitHub Pages”。

  3. 输入仓库的名称和说明(可选)。 如果您创建的是用户或组织站点,仓库名称必须为 <user>.github.io<organization>.github.io。 如果您的用户或组织名称包含大写字母,您必须小写字母。 更多信息请参阅“关于 GitHub Pages”。 创建仓库字段

  4. 选择仓库可见性。 更多信息请参阅“关于仓库”。 选择仓库可见性的单选按钮

  5. 选择 Initialize this repository with a README(使用自述文件初始化此仓库)使用自述文件初始化此仓库复选框

  6. 单击 Create repository(创建仓库)创建仓库的按钮

创建站点

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

警告:除非您的企业使用 企业托管用户,否则 GitHub Pages 站点在默认情况下在互联网上公开可用,即使站点的存储库是私有的或内部的。 您可以通过管理网站的访问控制来私下发布网站。 否则,如果站点的仓库中有敏感数据,您可能想要在发布前删除它。 更多信息请参阅“关于存储库”和“更改 GitHub Pages 站点的可见性”。

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

  2. 确定要使用的发布源。 更多信息请参阅“关于 GitHub Pages”。

  3. 如果所选发布源已存在,请导航到发布源。 如果所选发布源不存在,则创建发布源。

  4. 在发布源的根目录中,创建一个名为 index.md、包含要在网站主页上显示的内容的文件。

    提示: 如果存在 index.html,则将使用它而不是 index.md。 如果没有 index.htmlindex.md,将使用 README.md

  5. 配置发布源。 更多信息请参阅“配置 GitHub Pages 站点的发布来源”。

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

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

  8. (可选)如果要从私有或内部存储库发布项目站点,请选择站点的可见性。 在 "GitHub Pages" 下,选择 GitHub Pages visibility(可见性)下拉菜单,然后单击可见性。 更多信息请参阅“更改 GitHub Pages 站点的可见性”。 选择站点可见性的下拉菜单

    注意: 若要私下发布 GitHub Pages 网站,您的组织必须使用 GitHub Enterprise Cloud。 有关如何免费试用 GitHub Enterprise Cloud 的详细信息,请参阅“设置 GitHub Enterprise Cloud 试用版”。

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

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

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

后续步骤

您可以通过创建更多新文件向网站添加更多页面。 每个文件都将在网站上与发布源相同的目录结构中。 例如,如果项目网站的发布源是 gh-pages 分支,并且您在 gh-pages 分支上创建了名为 /about/contact-us.md 的新文件,该文件将在 https://<user>.github.io/<repository>/about/contact-us.html 下。

您还可以添加主题以自定义网站的外观。 更多信息请参阅“使用主题选择器添加主题到 GitHub Pages 站点”。

要更多地自定义您的站点,您可以使用 Jekyl - 内置 GitHub Pages 支持的静态站点生成器。 更多信息请参阅“关于 GitHub Pages 和 Jekyll”。

延伸阅读