为了我们这些制作README的人的利益。md文件在Atom(我是如何找到这个线程的):

apm install markdown-toc

https://atom.io/packages/markdown-toc

我刚刚为python-markdown编写了一个扩展，它使用它的解析器来检索标题，并将TOC输出为带有本地链接的markdown格式的无序列表。文件是

Md_toc.py(是Md_toc.py)

．.． 它应该放在markdown安装的markdown/extensions/目录中。然后，你所要做的就是输入anchor <a> tags，带一个id="…"属性作为引用-对于这样的输入文本:

$ cat test.md 
Hello
=====

## <a id="sect one"></a>SECTION ONE ##

something here

### <a id='sect two'>eh</a>SECTION TWO ###

something else

#### SECTION THREE

nothing here

### <a id="four"></a>SECTION FOUR

also...

．.． 扩展可以这样调用:

$ python -m markdown -x md_toc test.md 
* Hello
    * [SECTION ONE](#sect one)
        * [SECTION TWO](#sect two)
            * SECTION THREE
        * [SECTION FOUR](#four)

．.． 然后您可以将这个toc粘贴回您的标记文档中(或者在您的文本编辑器中有一个快捷方式，在当前打开的文档上调用脚本，然后将结果toc插入到同一文档中)。

注意，旧版本的python-markdown没有__main__.py模块，因此，上面的命令行调用将不适用于这些版本。

我不确定，markdown的官方文件是什么? 交叉引用可以只用括号[Heading]，也可以用空括号[Heading][]。

两者都使用pandoc进行工作。 所以我创建了一个快速bash脚本，它将用其TOC替换md文件中的$__TOC__。(你需要envsubst，它可能不是你发行版的一部分)

#!/bin/bash
filename=$1
__TOC__=$(grep "^##" $filename | sed -e 's/ /1. /;s/^##//;s/#/   /g;s/\. \(.*\)$/. [\1][]/')
export __TOC__
envsubst '$__TOC__' < $filename

只需使用带有插件的文本编辑器。

你的编辑器很可能有一个包/插件来为你处理这个问题。例如，在Emacs中，可以安装markdown-toc TOC生成器。然后在编辑时，只需反复调用M-x markdown-toc-generate-or-refresh-toc。如果你想经常这样做，那就值得一个键绑定。它擅长生成一个简单的TOC，而不会用HTML锚污染您的文档。

其他编辑器也有类似的插件，所以流行的列表是这样的:

器name: markdown-toc Vim: markdown-toc Atom: markdown-toc VSCode: markdown-toc

下面是一个生成目录的简单bash脚本。不需要特殊的依赖项，只需要bash。

https://github.com/Lirt/markdown-toc-bash

它可以很好地处理标题内的特殊符号，标记标题中的链接和忽略代码块。

你可以使用DocToc从命令行生成目录:

doctoc /path/to/file

要使链接与Bitbucket生成的锚点兼容，请使用——Bitbucket参数运行它。