在gh-pages中为java web项目创建项目文档

时间:2015-03-04 18:57:53

标签: git jekyll github-pages

我有一个基于maven的java web项目,主分支中有源代码。我想使用jekyll为该项目创建文档,并将文档与docs文件夹中的源一起提交。

因此,我在项目的根目录中初始化了一个名为docs的新jekyll站点

 $ jekyll new docs

现在我的项目根目录中有一个docs文件夹,我可以从中生成并提供文档。

 $ cd docs
 $ jekyll build 

一切都很好,我有docs / _site文件夹,里面有生成的HTML。 如何将此生成的HTML推送到gh-pages分支? 无论如何,github提供这样做吗?任何想法/建议/最佳实践重新:这个?

修改

主要问题是我的jekyll代码位于 master 而不是 gh-pages分支。从github的文档中我了解到我需要将jekyll站点推送到gh-pages目录。

如果我误解了,请纠正我。

1 个答案:

答案 0 :(得分:1)

诀窍是将生成的页面转移到gh-pages分支。一种方法是将docs/_site复制到临时位置,然后切换到gh-pages并将文件复制到那里:

$ cp -R docs/_site /tmp/      # Copy web page files to temporary location
$ git checkout gh-pages       # Checkout gh-pages branch
$ git rm -rf .                # Delete existing files
$ mv /tmp/_site/* .           # Move web page files to repo
$ git add -A                  # Add new files
$ git commit                  # Commit new files
$ git push origin gh-pages    # Push changes back to GitHub