如何组织GitHub wiki文件？

Question

如何组织GitHub wiki文件？

23

我已经将我的 GitHub 项目的维基克隆到本地，现在想要重新组织文件系统。默认情况下，添加到维基的不同页面都在父目录中创建:

/wiki
     home.md
     wiki_page_1.md
     ...

我希望有一个类似于这样的目录结构：

/wiki
  /setup
    setup_procedures.md
    index.md
  /development
    index.md
    tools.md
  /images
    front_page.png

我试图以类似的方式构建我的wiki文件，但对于.md文件却无效。不过，对于图片文件夹有效。有什么方法可以使它起作用吗？

- tsega

就我所知，有一个团队通过放弃Wiki的方式来解决这个问题，而是在代码库中维护他们的.md文件。他们创建了一个名为Docs的子文件夹（和其他文件夹）用于存储.md文件，并且还有一个单独指定的子文件夹用于存储所有图片和附件，需要时可以通过Wiki链接到它们。我对用户体验并不是很满意，但似乎对他们有效。 - ScottWelker

3个回答

2

我刚遇到了同样的问题，通过使用自定义菜单栏和使用常规Markdown，即标题和链接来创建文件夹结构，我已经解决了这个问题（有点）。

- Felipe

请问您可以发送一个示例吗？ - Noam Peled

2

例如，Spring Framework @NoamPeled - niaomingjian

2

返回翻译文本：-1 因为它实际上并不能处理页面组织，只是合并页面。这仅适用于少量内容/页面的情况。 - Fuzzy Logic

2

在2022年，这仍然不可能。
请为此功能请求投票支持。

- Floris Devreese

我们最终把我们的维基放在核心代码库中。在那里，我们可以按照我们的意愿进行层级设置。 - undefined

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- VonC · Accepted Answer

如果GitHub仍在使用github/gollum，那么如 "How can you use subdirectories in a GitHub wiki checkout?" 中所解释的，子文件夹不受支持（或者在分支时存在缺陷）。

最近版本的gollum/gollum已经支持该组织，尽管最近的PR（拉取请求）仍在修复相关问题（例如PR 787）。

OP tsega在评论中补充道：

我尝试自己查看Gollum wiki，发现您可以将文件组织到目录下，但这不是访问它们的方式。每个页面都从wiki的根目录访问，例如github.com/user/repo/wiki/file-name而不是github.com/user/repo/wiki/directory/file-name。文件名应该是唯一的，如果您想要适当的标题，它们需要大写并使用破折号（而不是下划线）。