GitHub 个来自文档和 Jekyll 源文件夹配置的页面

GitHub pages serving from docs and jekyll source folder config

标准 F#(在 ProjectScaffold 之后)的文档具有以下结构

- project
| - docs
| | content
| | files
| | output
| | tools

生成的文档保存到output,然后推送到gh-pages分支。

最近,GitHub 改变了服务页面的工作方式,现在您可以直接从 master 分支提供 docs 文件夹。问题是我希望提供的实际文件夹是 docs/output.

Jekyll 有一个 source 配置,允许我在本地执行此操作。我的 docs/_config.yml 只是:

source: output

如果我在本地 docs 文件夹中 运行 jekyll serve,效果很好。但是在推送到 GitHub 之后,页面仍然在 /output 前缀下提供。

显然 GitHub 覆盖了 source 选项。无论如何,这可以解决吗?

是不是Jekyll的文档不清楚。是的

新 github 页发布 branch/folder :

可用的选项是 (doc) :

  • gh-pages 分支
  • 主分支
  • master 分支/docs 文件夹
  • 禁用 GitHub 个页面。

前三个选项定义了您的根发布文件夹。

Github 页面使用此根文件夹生成您的站点。 You cannot override source key in your _config.yml.

您可以将源代码存储在 _docs 文件夹中并在文档中输出

- project
| - _docs
| | content
| | files
| | tools
|
| - docs << output here