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 的页面。

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

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

Answer 2

当您在项目的 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 3

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

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

这个过程很痛苦。我很惊讶这个“gollum”wiki 有任何接受度。

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

Answer 4

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

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

Answer 5

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

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

Answer 6

我已经实现了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
  

创建/更新您的 wiki 菜单：

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

GitHub 会自动生成文档目录：

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