ToC或GitHub Wiki中的边栏

如何在GitHub Wiki中创buildToC或侧边栏菜单?

我看到了一些提及,gollum后端似乎支持它,但是我怎样在当前的GitHub项目中做到这一点?

它应该最好基于我自动在页面中的标题。

这些链接都提到它,但不显示如何做到这一点:

  • https://gist.github.com/379469 – 一些JavaScript黑客入侵
  • https://github.com/blog/774-git-powered-wikis-improved – GitHub提到它:

    “GitHub Wiki对脚注和侧边栏有一些logging的function,这是我们一些基于git的Wiki作者所熟悉的。这个新的Wiki编辑器为您提供了有限的基于网页的页脚编辑function。 “

尽pipe您的解决scheme有效,但使用GitHub的Web界面还是有一个更简单的方法。 您可以简单地创build一个名为_Sidebar和/或_Footer

请参阅向Github WIKI添加目录中的详细说明。

好的。 让我看看我是否正确理解这一点:

  1. 克隆你的GitHub wiki。 (wiki中有一个Git部分,你可以签出类似wiki的代码。)
  2. 创build_Sidebar.md
  3. 在普通的wiki页面中,使用侧边栏的[[link]]
  4. 提交并推回到GitHub

这个过程是一个痛苦的屁股。 我很惊讶这个“gollum”wiki有任何接受。

另外: _Sidebar.md因此是所有页面的全局 。 我将不得不把我的维基组织到文件夹中,所以我可以为不同的页面定义不同的侧边栏。

当你在你的项目的维基,有一个链接添加一个自定义的侧边栏 。 点击。

在这里输入图像说明

现在,您可以编辑一个页面,就像编辑任何其他Markdown页面一样。 要制作目录,您必须手动完成。 没有自动化方法(截至2014年8月)。 举个例子:

 # My menu * [Home][home] * [Technical documentation][techdocs] * [User manual][usermanual] [home]: https://github.com/myproject/wiki/Home [techdocs]: https://github.com/myproject/wiki/Technical-documentation [usermanual]: https://github.com/myproject/wiki/User-manual 

请注意,原来的问题是关于创build一个侧边栏(很容易,在答案中解决)或实际的目录(未回答)。

我可以说的一件事是,gollum 2.1 wiki语法允许使用[[_TOC_]]标记,但是GitHub wiki将不会识别(还?)。

我想这在Gollum的README有描述。 (请参阅标题和侧栏部分。)

本质上,您在包含页面内容的目录中创build一个_footer.ext_sidebar.ext

我刚刚创build了一个Python脚本 ,它根据wiki git中的文件夹结构和页面,在GitHub的_Sidebar.md中生成一个索引。

在这里输入图像说明