原文地址:
Configuring a publishing source for GitHub Pages - User Documentation
配置 GitHub Pages 发布源
你可以配置 GitHub Pages
,以便从主分支、gh-pages
分支,或主分支的 /doc
文件夹发布你的 Pages
项目,或是其他符合特定条件的 Pages
站点。
如果你的站点是一个拥有名字是 <username>.github.is
或 <orgname>.github.io
的个人或企业站点,你将无法从其他不同位置发布你的站点。这种拥有仓库名的用户和组织的 Pages
将只可以从主分支发布。
了解更多关于 GitHub Pages
站点的不同类型,可以查看 User, Organization, and Project Pages - User Documentation。
没有用户名命名方案的仓库的默认源配置
用于发布站点源文件的默认设置取决于您的站点的类型和仓库中存储的分支。
如果你的仓库没有 master
和 gh-pages
分支,你的 GitHub Pages
的发布源将是空,并且站点是未发布的。
在你创建了 master
分支 或 gh-pages
分支后,你可以将一个设置为你的发布源,并且你的站点会发布。
如果你仅使用 master
分支 或gh-pages
分支使用或更新你的站点仓库,那么你的站点源设置将自动为该分支可用。
允许 GitHub Pages 从 master
分支 或 gh-pages
分支发布你的站点
在选择 master
分支 或 gh-pages
作为发布源之前,本地仓库必须要存在该分支。如果你没有 master
分支或gh-pages
分支,你可以创建他们,并且回到资源设置以更改发布源。
- 登录
GitHub
,跳转到你的GitHub Pages
站点的仓库。 - 在仓库名的下方,点击 Settings。
- 点击
Select
下拉选项菜单来选择master
或gh-pages
分支作为你的GitHub Pages
发布源。 - 点击 Click 保存。
从 master
分支的 /doc
文件夹目录发布你的 GitHub Pages
站点
为了从 master
分支的 /doc
目录发布你的站点,你的仓库必须有一个 master
分支,并且:
- 在仓库的根目录有一个 /doc
目录
- 没有遵循 <username>.github.io
或 <orgname>.github.io
的命名方案
发布站点前,GitHub Pages
会读取所有的文件,包括 /doc
目录的 CNAME
文件。例如,当你通过 GitHub Pages
设置修改你的个性化域名时,这个域名会写入 /docs/CNAME
文件。
注意:如果在设置好后将
master
分支的/doc
目录移除,你的站点不会被建立,而且会得到一个关于丢失/docs
目录的错误信息。
- 登录
GitHub
,跳转到你的GitHub Pages
站点的仓库。 - 在
master
分支的根目录创建/docs
目录 - 在仓库名的下方,点击Settings
- 点击
Select
下拉选项菜单来选择master branch / docs folder
作为你的GitHub Pages
发布源。 - 点击保存。
延伸阅读
Viewing branches in your repository - User Documentation