构建github页面

时间:2011-03-08 06:51:15

标签: github

如果您有一个名为http://username.github.com的网站和一个名为projectname的项目,那么

  1. 使用http://github.com/username/projectname/tree/gh-pages a)镜像您的主分支,或b)创建描述项目的网页(将在[{1}}中反映)或
  2. 没有http://username.github.com/projectname 分支?

2 个答案:

答案 0 :(得分:5)

我对 pages.github.com 中提供的gh_pages的理解是,它适用于:

  • 创建一个单独的分支:你的repo现在有两个根(一个用于master和所有dev分支,一个用于gh_pages用于GitHub发布的内容)。
    当由GitHub管理时,gh_pages分支的根有一个特殊的处理。
  • “将内容发布到网络上”:这可以是您想要的任何内容 因此,如果您不需要完整的文档空间,可以使用readme.md文件或index.html页面(“用户页面”)。
    help.github.com 本身被组织为documents within a gh_pages branches

答案 1 :(得分:2)

我通常根本没有项目页面(我的大多数公共github项目都是其他开源项目的镜像),但在我所做的事情上,我有一个描述该项目的网页。

虽然我只是有一个想法:可能很整洁,使一个项目的gh-pages分支包含一个突出显示的超链接版本的代码(通过Doxygen运行它并让它只生成交叉引用的源而不是文档,例如)。