从master到master / docs或gh-pages分支发布GitHub Pages

时间:2019-10-15 22:25:31

标签: github deployment github-pages

我已经能够从master分支在GitHub Pages上发布我的域下的GitHub站点,而没有问题,但是在文档中说使用gh-pages分支或master / docs来发布项目。 我的主页index.html文件/资产也有一个存储库,我在其中链接到每个已发布的GitHub存储库(已发布到我的domain.com/repo-name)。

为什么我可以从master分支发布?有什么理由要从gh-pages分支或master / docs发布来代替发布项目存储库吗?

2 个答案:

答案 0 :(得分:0)

GitHub Pages可以从以下任何来源发布:gh-pages分支,master / docs或仅从仓库本身发布。您更倾向于使用哪种路线。

例如,Jekyll正在使用master / docs选项进行发布。 docs文件夹外的其余回购用于实际的Jekyll代码。一个可能的原因是具有新功能的PR还必须包括该新功能的文档。否则,它将不会合并。

gh-pages选项意味着可以对代码和文档进行不同的调整或管理。它们生活在相同的仓库中,但是分支可以以不同的速度增长。

就技术差异而言,据我所知,每种选择都没有技术成本/收益。这就是您想要组织代码和文档的方式。

希望有帮助!

答案 1 :(得分:0)

GitHub要求用户和组织站点必须从master构建,而项目站点可以从gh-pages构建。如果我理解正确,则您是在发布到您的用户站点,即您的用户名 .github.io。 enter image description here