如何在/ docs下创建一个充当gh-pages的子模块?

时间:2017-09-26 07:41:20

标签: github github-pages

我正在尝试使用一个github存储库作为许多github存储库的文档模板。所以,我创建了一个带有文档模板的/ docs(docs.git)存储库(repo#1)。我想将此存储库作为子模块添加到我的其他存储库(repo#2 +)。我不是肯定的我正确地做这件事或者是否可能。

git clone <repo #2>
git submodule add <repo #1 called docs.git> #This creates a docs folder
git add .
git commit -m 'Initial commit'
git push origin master

Repo#1确实包含gh-pages的有效文件,因为当我将文档指向master分支或将其全部提交给gh-pages分支时,它作为原始存储库中的文档工作。

当我转到repo#2时,我尝试选择new / docs子模块目录作为文档的源,但它失败了。 &#34;主分支/ docs文件夹 仅使用GitHub页面的/ docs文件夹。&#34;在“设置”下显示为灰色。

有谁知道为什么这不起作用或如何使它工作?我的印象是,如果我将docs.git repo添加为子模块,则每个存储库都可以根据需要对存储库进行各自的更改,并从原始文件中获取更改。

谢谢!

1 个答案:

答案 0 :(得分:0)

来自Github支持:

目前无法在docs目录中使用子模块,但我们可以将您的反馈意见传递给团队,以便考虑将来的改进。

docs目录确实可以使用子树,因此您可以选择使用子树而不是子模块链接到文档存储库:

git subtree add --prefix = docs

在添加子树之前,您需要删除子模块。

更多信息显示以下子模块与子树的用法: https://gist.github.com/kvnsmth/4688345