使用GitHub页面时了解Jekyll和gh-pages分支

时间:2015-12-06 02:11:59

标签: git github jekyll github-pages

我正在使用Jekyll和GitHub页面(特别是项目页面)。我创建了2个分支:

  1. master
  2. gh-pages
  3. documentation解释说网站内容存储在gh-pages分支中,该内容将由Jekyll呈现。输出将在诸如username.github.io/project-name。

    之类的URL中提供

    如果我在本地jekyll new mysite分支中运行master,则会在该分支中创建_config.yml,_posts,_sites等。此时如果我运行jekyll serve,我可以在localhost:4000看到一个基本站点(这很棒)。

    我的问题:

    考虑到我目前在我的master分支中的内容似乎正在运行,gh-pages分支的目的是什么?究竟应该包含在a)master分支和b)gh-pages分支中?

    提前致谢。

2 个答案:

答案 0 :(得分:4)

阅读Github pages documentation

如果您想推送代码并让Github生成您的网站:

您只需要对代码进行版本控制,而不是生成的页面版本。因此,只需要一个分支。

  1. 对于用户/组织Github页面 (github.com/username/username.github.io),您发布了代码 master
  2. 对于项目页面(github.com/username/projectRepository),您可以在gh-pages中发布代码。在这里,您不需要master分支。
  3. 如果您需要在本地生成您的网站,并且只在Github上发送生成的网页:

    您需要对代码和生成的页面进行版本控制。因此,需要两个分支。

    1. User/organisation存储库:基本代码进入code(或 无论你怎么命名,分支和生成的页面都在master
    2. Project存储库:基本代码进入master(或任何你 将它命名为分支,生成的页面进入gh-pages

答案 1 :(得分:0)

如github gh-pages中所述:

  

滚动香草,或为您的项目生成一个网站,以便快速入门。

gh-pages只是一个github特定分支,允许您将其用作您的网站。

这意味着如果您在此页面中有index.html,则可以直接在浏览器中查看。

您使用此链接格式:username.github.io/project_name

可以在此处找到更多信息:https://pages.github.com/