在 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 是否提供这样做？任何 ideas/suggestions/best 做法 re:this?

编辑

主要问题是我的 Jekyll 代码在 master 而不是 gh-pages branch。从 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

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

Creating project documentation for java web project in gh-pages

git

jekyll

github-pages

编辑