在本地使用 Github 个 wiki

Working with Github wikis locally

我在 Github 上启动了一个新的 repo,并将其克隆到我的本地机器上:~/org-name/repo-name

我想为该存储库创建一个 github wiki。我应该在哪里克隆它以在本地处理它?

是否应该是:~/org-name/repo-name/wiki 然后也许我将 wiki/ 中的所有内容都添加到 exclude/ignore 列表中?还是嵌套 git 回购的形式不好?不确定使用 wiki 是否有什么不同,因为它们已连接到该 repo。

如果答案是否定的,那么我假设我应该在与我的存储库相同的级别创建另一个名为 ~/org-name/repo-name_wiki 的目录。

先谢谢了,还在学习中...

您可以嵌套 Git 存储库,但我不建议这样做。这是您不需要的复杂性。很容易忘记它们是两个独立的存储库,并且不小心使它们相互依赖。也很容易忘记您所在的目录并开始在 wiki 中发出 Git 命令并认为您在源代码中,或者 vice-versa。在你的源代码中有一个额外的子目录可能会扰乱你的构建系统。

嵌套存储库只有在它们相互依赖时才应该完成,并且只有在正式声明时才使用 git submodule。 wiki 和 source 是相关的,但它们并不相互依赖。

我建议将源代码和 wiki 存储库完全克隆到一个单独的目录中,可能在项目旁边。

projects/
    project-name/
    project-name-wiki/

或者在公共子目录下克隆项目源和 wiki。

projects/
    project-name/
        src/
        wiki/

您选择哪种取决于您希望如何组织项目。