GitHub Wiki 中的 ToC 或侧边栏

Question

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

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

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

这些链接都提到了它，但没有展示如何去做：

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

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

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

Answer 1

虽然您的解决方案有效，但使用 GitHub 的 Web 界面有一种更简单的方法。 您可以简单地创建一个名为_Sidebar和/或_Footer 。

请参阅具有多级.

编辑原来的文章不见了，我在缓存中找不到它，所以我更新了链接。

Answer 2

当您在项目的 wiki 中时，有一个链接Add a custom sidebar 。 单击那个。

现在您有一个可以像编辑任何其他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 3

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

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

这个过程是痛苦的。 我很惊讶这个“咕噜”维基有任何接受。

另外： _Sidebar.md因此对于所有页面都是全局的。 我必须将我的 wiki 组织到文件夹中，这样我才能为不同的页面定义不同的侧边栏。

Answer 4

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

我可以说的一件事是 gollum 2.1 wiki 语法允许使用[[_TOC_]]标签，但 GitHub wiki 无法识别（还？）。

Answer 5

我认为这在Gollum README有描述。 （请参阅标题和侧边栏部分。）

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

Answer 6

我刚刚创建了一个Python脚本 ，它根据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 admin 中所示）：

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

结果（定制订单）：

• 家
• 安装
• 用法
  • 初始化模式
  • 命令行修饰符
• 路线图

先决条件：

• 在本地克隆您的 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 管理员上创建新页面/重命名页面

• 在您的 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: 。