GitHub Wiki中的ToC或侧栏

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

我看到有人提到它，而gollum后端似乎支持它，但是在当前的GitHub项目中我该如何做呢

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

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

• -一些JavaScript黑客
• -GitHub提到它：
  GitHub Wiki有一点文档化的页脚和侧边栏功能，这是一些 我们基于git的Wiki作者很熟悉。新的Wiki编辑器为您提供有限的基于web的 编辑网站上的页脚和侧栏。“

---

我认为这一点已在本手册中有所描述。（请参见标题和侧栏部分。）

---

基本上，在包含页面内容的目录中创建一个

\u footer.ext

和

\u sidebar.ext

。

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

克隆您的GitHub wiki。（wiki中有一个Git部分。您可以签出类似wiki的代码。）

创建

\u侧边栏.md

在普通wiki页面中，使用侧边栏的

[[link]]

提交并推回GitHub

这个过程真是让人头疼。我很惊讶这个“咕噜”维基能被接受

---

另外：

\u Sidebar.md

因此对所有页面都是全局的。我必须将我的wiki组织到文件夹中，以便为不同的页面定义不同的侧栏。

当您的解决方案工作时，使用GitHub的web界面有一种更简单的方法。您只需创建一个名为

\u边栏

和/或

\u页脚

的页面

请参阅中的详细说明

---

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

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

---

我可以说的一件事是，gollum 2.1 wiki语法允许使用

[[[u TOC]]]

标记，但GitHub wiki不会识别它（还？）。

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

现在，您可以像编辑任何其他页面一样编辑一个页面。要制作目录，您必须手动完成。没有自动方法（截至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

---

我已经实现了npm模块，以帮助github用户轻松创建和维护侧栏菜单

来源和结果：

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

结果（使用定制订单）：

先决条件：

• 本地克隆github wiki存储库（显示在wiki UI的右下角）
• 安装github wiki侧栏

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

  ---

  git cloneGitHub将自动生成文档目录：
  
  将文档类型设为ascidoc而不是Markdown
  在文档开头插入
  ：toc:
  根据文档，你可以为不同的文件夹添加不同的边栏：“边栏会影响其目录中的所有页面以及没有边栏文件的任何子目录。”请参阅：我开发了GitHub Wikifier：一个预提交Git钩子，它将生成你所需的所有目录。只要写下你的内容，让它接管。也许值得一看。关于艾萨克斯：@MarioRicalde的代码移到了@CodeSherpa，可以在
  https://github.com/[user]/[repo]/wiki/_边栏/_编辑
  和
  https://github.com/[user]/[repo]/wiki/\u Footer/\u edit
  这篇文章很棒，但给出了有关如何获取wiki URL的错误（或过时）信息。如果你和我一样迷路，你必须使用URL
  https://github.com//.wiki.git
  或SSH
  git@github.com：/.wiki.git
  。这些详细说明非常糟糕。什么是
  [[link]]
  ？将URL放在其中会导致整个URL显示。@Pithikos这是Github Markdown speak。这些说明不是教你降价的。它们是用来解释边栏的，最好的解释方法就是用一个具体的例子。你运气好吗？这是一个非常令人沮丧的问题，因为Trac可以轻松完成所有这些事情。我认为，对于如何“根据我在页面中的标题自动”创建目录的原始问题，更好的答案是，这在GitHub Wiki中目前是不可能的。这目前是一个悬而未决的问题（懒得查数字）数百人对此发表了评论。GitHub还没有回复：（截至2017年1月19日，GitHub的主要问题是：1.2。
  git clone <https://github.com/<username>/<my-project-name>.wiki.git
  npm install -g 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