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

Question

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

所以，我在我的项目根目录中初始化了一个名为 docs 的新 jekyll 站点

 $ jekyll new docs

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

 $ cd docs
 $ jekyll build 

一切都很好，我有 docs/_site 文件夹，其中包含生成的 HTML。 如何将生成的 HTML 推送到 gh-pages 分支？ github是否提供了这样做？有什么想法/建议/最佳实践 re:this？

编辑

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

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

Answer 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