管理代码和同一git目录结构中的文档

时间:2011-11-16 02:31:57

标签: github

我将一个项目从Google Code转移到了Github。该项目在一个目录结构中包含代码和文档。

我想使用Github的“Pages”功能来托管html文档。理想情况下,我想做1 push来提交对代码和代码的更改。文档。

我怎样才能做到这一点?

1 个答案:

答案 0 :(得分:1)

说到GitHub pages,您有用户页面和项目页面 我假设您正在谈论后者,这意味着您需要创建自己的gh-pages分支,从这个新的空分支中的master分支复制您的文档文件,如GitHub文档页面中所述

从那里开始,当您在mastergh-pages分支中都有新的提交时,您可以一次推送两个分支(git push --all

当您绝对想要同时查看两个目录结构时,问题就开始了 最简单的解决方案是:

  • master分支上设置了一个repo的克隆。
  • gh-pages分支上的一个克隆(同一个回购)。
  • 从第一个repo到第二个repo的符号链接(允许你对同一目录结构中的代码和doc进行修改。自Vista以来,Windows甚至支持符号链接。)
  • 一个git别名脚本,以便自动执行命令序列' git push master origin; cd ../secondRepo; git push gh-pages origin'

您可以尝试将doc repo作为主仓库的子模块,但是......这似乎更复杂,应该:看到" How to add a git repo as a submodule of itself? (Or: How to generate GitHub Pages programmatically?)"。


2016年8月更新: Simpler GitHub Pages publishing 现在允许将您的网页文件保存在相同分支的子文件夹中(不再需要gh-pages) :

Now you can select a source in your repository settings and GitHub Pages will look for your content there.

您最终可以在一个分支中更新代码和页面。