GitHub Wiki中的ToC或补充工具栏

Question

如何在GitHub Wiki中创建ToC或侧边栏菜单？

我看到一些提及它和gollum后端似乎支持它，但我如何在当前的GitHub项目中做到这一点？

最好基于我在页面中的标题。

这些链接都提到了它，但没有说明如何做到这一点：

• https://gist.github.com/379469 - 一些JavaScript黑客

• https://github.com/blog/774-git-powered-wikis-improved - GitHub提到它：

  “GitHub Wiki对于页脚和侧边栏有一些记录不足的能力 我们的基于git的Wiki作者很熟悉。新的Wiki编辑器为您提供有限的基于Web的编辑器 编辑您网站上的页脚和侧边栏。 “

Answer 1

虽然您的解决方案有效，但使用GitHub的Web界面可以更轻松地完成此操作。您只需创建名为_Sidebar和/或_Footer的页面。

请参阅 Github Wiki sidebar menu builder with multi-level 中的详细说明。

修改原始文章消失了，我在缓存中找不到它，所以我更新了链接。

Answer 2

好。让我看看我是否理解正确：

1. 克隆你的GitHub维基。 （wiki中有一个Git部分。你可以查看类似wiki的代码。）
2. 创建_Sidebar.md
3. 在常规维基页面中，使用[[link]]作为侧边栏
4. 提交并推回GitHub

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

另外： _Sidebar.md因此全局所有网页。我必须将我的wiki组织到文件夹中，这样我就可以为不同的页面定义不同的侧边栏。

Answer 3

当您在项目的Wiki中时，有一个链接添加自定义侧边栏。点击它。

现在，您可以编辑一个页面，就像编辑任何其他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

Answer 4

请注意，原始问题是关于创建侧栏（简单，在答案中解决）或实际目录（未回答）。

我可以说的一点是，gollum 2.1 wiki语法允许[[_TOC_]]标签，但是GitHub wiki不会识别（但是？）。

Answer 5

我认为这在Gollum README中有所描述。 （参见标题和侧栏部分。）

基本上，您在包含页面内容的目录中创建_footer.ext和_sidebar.ext。

Answer 6

我刚刚创建了a Python script，它根据wiki git中的文件夹结构和页面在GitHub的_Sidebar.md中生成索引。

Answer 7

我已经实现了npm模块github-wiki-sidebar来帮助github用户轻松创建和维护侧边栏菜单。

来源和结果： https://raw.githubusercontent.com/wiki/adriantanasa/github-wiki-sidebar/images/github-wiki-sidebar-generator.png

源页面（在Wiki管理员中显示）：

Home
Installation
Roadmap
Usage
Usage: Command line modifiers
Usage: Init Mode

结果（使用自定义订单）：

• Home
• Installation
• Usage
  • Init mode
  • Command line modifiers
• Roadmap

<强>预要求：

• 在本地克隆您的github wiki存储库（显示在Wiki UI的右下角）

• 安装github-wiki-sidebar

  git clone <https://github.com/<username>/<my-project-name>.wiki.git
  npm install -g github-wiki-sidebar
  

创建/更新您的维基菜单：

• 在您的github.com wiki admin
上创建新页面/重命名页面

• 在本地执行wiki存储库文件夹中的github-wiki-sidebar脚本

  cd /path/to/<my-project-name>.wiki
  # this fetches latest changes, generates sidebar file (_Sidebar.md) and pushes changes to github
  github-wiki-sidebar --git-push
  

该模块允许自定义降价输出，包括项目的排序，类别分隔符，菜单模板，链接格式等。

Answer 8

GitHub将自动生成文档目录：

1. 将文档类型设为AsciiDoc而不是Markdown。
2. 在文档开始处插入:toc:。