GitHub Wiki中的ToC或补充工具栏

87

如何在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的对网站上的页脚和侧边栏的有限编辑。 ”

github wiki

— 沃尔
source

3

我开发了GitHub Wikifier：一个预先提交的Git Hook，它将生成您将需要的所有目录。只需编写您的内容，然后将其接管即可。可能值得一看。github.com/kuroir/GitHub-Wikifier

— MarioRicalde

在Isaacs上：github.com/isaacs/github/issues/504

— Ciro Santilli郝海东冠状病六四事件法轮功

@MarioRicalde的代码移至github.com/hybridgroup/GitHub-Wikifier

— Jonny

76

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

请参阅具有多个级别的Github Wiki侧边栏菜单构建器中的详细说明。

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

— 机器人
source

7

@CodeSherpa他们在访问https://github.com/[user]/[repo]/wiki/_Sidebar/_edit和https://github.com/[user]/[repo]/wiki/_Footer/_edit

— nicerobot

1

这篇文章很棒，但是给出了有关如何获取Wiki URL的错误（或过时）信息。如果您像我一样迷路，则必须使用URLhttps://github.com/<username>/<projectname>.wiki.git或SSH git@github.com:<username>/<projectname>.wiki.git。

— NightOwl888

1

这些详细说明非常糟糕。什么是[[link]]？在其中放置一个URL会显示整个URL。

— Pithikos

3

@Pithikos，是Github Markdown讲话。该说明并不在那里教您Markdown。他们在那里解释侧边栏。

— nicerobot 2014年

2

@nicerobot并解释事情的最好方法是使用一个具体的例子..

— Pithikos

26

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

— 皮蒂科斯
source

25

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

克隆您的GitHub Wiki。（Wiki中有一个Git部分。您可以签出类似Wiki的代码。）
创建 _Sidebar.md
在普通Wiki页面中，[[link]]用于侧边栏
提交并推回GitHub

这个过程是一个痛苦的过程。我很惊讶这个“古兰经”维基没有被接受。

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

— 沃尔
source

2

根据文档，您可以为不同的文件夹添加不同的侧边栏：“侧边栏会影响其目录中的所有页面以及不具有侧边栏文件的所有子目录。” 参见：github.com/github/gollum

— Subfuzion 2012年

10

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

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

— 标记
source

4

你有运气吗？来自Trac的所有这些事情都很容易完成，这实在令人沮丧。

— 13年

我认为，有关如何“自动基于页面中的标题”创建目录的原始问题的更好答案是，当前使用GitHub Wiki是不可能的。

— avernet 2014年

目前，这是一个开放的问题（懒得查找数字），数百人对此发表了评论。尚未从GitHub返回任何消息：(

— abalter

截至2017

— ckib16

4

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

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

— Seandavi
source

2

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

结果（具有定制顺序）：

前提条件：

在本地克隆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

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

— 阿达纳萨
source

0

GitHub将自动生成文档目录：

使文档类型为AsciiDoc而不是Markdown。
:toc:在文档的开头插入。

— 多格韦瑟
source