更新2022 - 02年

在VSCode中，检查扩展“Markdown All In One”。自动生成并更新减记的TOC。

安装扩展。 将光标放在您想要插入TOC的位置。 运行命令“Markdown All in One:创建目录” 享受吧!

我创建了两个选项来生成一个toc的github风味markdown:

DocToc命令行工具(源代码)需要node.js

Installation:

NPM install -g doctoc

Usage:

doctoc。向当前目录和所有子目录中的所有markdown文件添加目录。

DocToc WebApp

如果你想先在网上试试，去doctoc网站， 粘贴标记页面的链接，它将生成一个表 可以插入标记文件顶部的内容。

Github维基和锚

正如Matthew Flaschen在下面的评论中指出的那样，对于其维基页面，GitHub之前并没有生成doctoc所依赖的锚。

更新:但是，他们修复了这个问题。

它不是自动的，但它使用notepad++正则表达式:

用第二个替换所有第一个(删除所有没有标题的行)

^##(#?)(#?)(.*?)$(.|\r|\n)*?(?=^##|\z)
-\1\2 [\3](#\3)\n

然后(将头III转换为空格)

-##
        -

然后(将标题II转换为空格)

-#
    -

然后(删除链接标题开头和结尾未使用的字符)

\[ *((?:(?![ .:#!\?;]*\])[^#])*)[ #:!\?;]*\]
[\1]

然后(转换最后一个符号小写和破折号而不是空格)

\]([^ \r\n]*) ([^\r\n ]*)
]\L\1-\2

删除未使用的最后磅和初始破折号:

(?:()[-:;!\?#]+$|(\]#)-)
\1\2

删除链接中无用的字符:

(\].*?)(?:\(|\))
\1

最后在最后链接的周围加上圆括号:

\](?!\()(.*?)$
\]\(\1\)

瞧!如果你重复足够多的时间，你甚至可以把它放在一个全局宏中。

我的同事@schmiedc和我已经创建了一个GreaseMonkey脚本，它在h1按钮的左侧安装了一个新的TOC按钮，它使用优秀的markdown-js库来添加/刷新目录。

与doctoc等解决方案相比，它的优势在于集成到GitHub的wiki编辑器中，不需要用户使用命令行(并要求用户安装node.js等工具)。在Chrome中，它通过拖拽到扩展页面来工作，在Firefox中，你需要安装GreaseMonkey扩展。

它将与普通markdown工作(即它不能正确处理代码块，因为这是一个GitHub扩展markdown)。贡献的欢迎。

Github调味Markdown使用红地毯作为他们的Markdown引擎。 摘自RedCarpet回购:

:with_toc_data -添加HTML锚的每个头在输出HTML， 允许链接到每个部分。

似乎你需要在渲染器级别设置这个标志，这在Github上显然是不可能的。然而，Github Pages的最新更新，似乎自动锚定是为标题打开的，创建可链接的标题。这不是你想要的，但它可能会帮助你更容易地为你的文档创建一个TOC(尽管是手动的)。

使用coryfklein/doctoc, thlorenz/doctoc的一个分支，它不会在每个目录中添加“由doctoc生成”。

npm install -g coryfklein/doctoc