Creating a GitHub Pages site
You can create a GitHub Pages site in a new or existing repository.
GitHub Pages 可用于具有 GitHub Free 的公共仓库,以及具有 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和私有仓库。
本文内容
Creating a repository for your site
如果站点是一个独立的项目,您可以创建新仓库来存储站点源代码。 如果站点与现有项目关联, 您可以将站点的源代码添加到该项目仓库中的 gh-pages
分支或 master
分支上的 docs
文件夹。 例如,如果您创建站点来发布已经在 GitHub Enterprise 上的项目文档, 您可能想要将站点的源代码存储在与项目相同的仓库中。
如果要在现有仓库中创建站点,请跳至“创建站点”一节。
-
在任何页面的右上角,使用 下拉菜单选择 New repository(新建仓库)。
-
使用 Owner(所有者)下拉菜单选择你想要拥有仓库的帐户。
-
输入仓库的名称和说明(可选)。 如果您创建的是用户或组织站点,仓库名称必须为
<user>.github.io
或<organization>.github.io
。 更多信息请参阅“关于 GitHub Pages”。 -
选择将仓库设为公共或私有。 公共仓库对每个 您的 GitHub Enterprise Server 实例 用户可见,而私有仓库仅您以及您所分享的人才可访问。 更多信息请参阅“设置仓库可见性”。
-
选择 Initialize this repository with a README(使用自述文件初始化此仓库)。
-
单击 Create repository(创建仓库)。
Creating your site
必须先在 GitHub Enterprise 上有站点的仓库,然后才可创建站点。 如果未在现有仓库中创建站点,请参阅“为站点创建仓库”。
-
在 GitHub Enterprise 上,导航到站点的仓库。
-
如果您创建的是项目站点,请决定要使用哪个发布源。 如果您创建的是用户或组织站点,您必须将站点的源代码存储在
master
分支上。 更多信息请参阅“关于 GitHub Pages”。 -
If your chosen publishing source already exists, navigate to the publishing source. If your chosen publishing source doesn't exist, create the publishing source.
-
In the root of the publishing source, create a new file called
index.md
that contains the content you want to display on the main page of your site. -
如果您使用的是项目站点的非默认发布源,请配置您的发布源。 更多信息请参阅“配置 GitHub Pages 站点的发布来源”。
-
在仓库名称下,单击 Settings(设置)。
-
要查看您已发布的站点,请在“GitHub Pages”下点击您的站点 URL。
注:对站点的更改在推送到 GitHub Enterprise 后,最长可能需要 20 分钟才会发布。 如果一小时后仍然在浏览器中看不到您的更改,请参阅“关于 GitHub Pages 站点的 Jekyll 构建错误”。
注:如果网站的源文件位于默认发布源 - master
(对于用户和组织站点)或 gh-pages
(对于项目站点)- 但您的站点未自动发布,请确保有一个拥有管理权限和经验证的电子邮件地址的人已推送到默认发布源。
后续步骤
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.md
.
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. 更多信息请参阅“关于 GitHub Pages 和 Jekyll”。