我刚刚为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模块，因此，上面的命令行调用将不适用于这些版本。

您还可以使用pandoc，它是将“一种标记格式转换为另一种标记格式”的“瑞士军刀”。如果您提供——toc参数，它可以在输出文档中自动生成一个内容表。

提示:——toc需要-s(它会生成一个独立的文档)，否则不会生成目录。

示例shell命令行:

./pandoc -s --toc input.md -o output.md

我使用这个网站markdown -TOC创建者，有些人可以粘贴他的整个markdown条目，网站自动创建所有必需的标签和TOC(内容表)，所以有些人可以很容易地复制粘贴到他自己的文档中。

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

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

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

MultiMarkdown Composer似乎生成了一个目录来辅助编辑。

也可能存在这样或那样的库，它们可以生成TOC:参见Python Markdown TOC扩展。

如果使用Sublime文本编辑器，MarkdownTOC插件工作得很漂亮!看到的:

https://packagecontrol.io/packages/MarkdownTOC https://github.com/naokazuterada/MarkdownTOC

安装完成后，点击Preferences—> Package Settings—> MarkdownTOC—> Settings—User，自定义设置。以下是你可以选择的选项:https://github.com/naokazuterada/MarkdownTOC#configuration。

我的建议如下:

{
  "defaults": {
    "autoanchor": true,
    "autolink": true,
    "bracket": "round",
    "levels": [1,2,3,4,5,6],
    "indent": "\t",
    "remove_image": true,
    "link_prefix": "",
    "bullets": ["-"],
    "lowercase": "only_ascii",
    "style": "ordered",
    "uri_encoding": true,
    "markdown_preview": ""
  },
  "id_replacements": [
    {
      "pattern": "\\s+",
      "replacement": "-"
    },
    {
      "pattern": "&lt;|&gt;|&amp;|&apos;|&quot;|&#60;|&#62;|&#38;|&#39;|&#34;|!|#|$|&|'|\\(|\\)|\\*|\\+|,|/|:|;|=|\\?|@|\\[|\\]|`|\"|\\.|\\\\|<|>|{|}|™|®|©|%",
      "replacement": ""
    }
  ],
  "logging": false
}

要插入目录，只需单击文档顶部想要插入目录的位置，然后转到工具—> Markdown TOC—> insert TOC。

它将插入如下内容:

<!-- MarkdownTOC -->

1. [Helpful Links:](#helpful-links)
1. [Sublime Text Settings:](#sublime-text-settings)
1. [Packages to install](#packages-to-install)

<!-- /MarkdownTOC -->

注意<!-- -->它为您插入的HTML注释。这些是特殊的标记，帮助程序知道ToC在哪里，以便它可以自动更新它为您每次保存!所以，保持这些完好无损。

为了更加花哨，在它周围添加一些<details>和<summary> HTML标记，使ToC可折叠/可展开，如下所示:

<details>
<summary><b>Table of Contents</b> (click to open)</summary>
<!-- MarkdownTOC -->

1. [Helpful Links:](#helpful-links)
1. [Sublime Text Settings:](#sublime-text-settings)
1. [Packages to install](#packages-to-install)

<!-- /MarkdownTOC -->
</details>

现在，你得到了这个超级酷的效果，如下图所示。在我的eRCaGuy_dotfiles主自述文件中看到它的作用，或者在我的Sublime_Text_editor自述文件中看到它的作用。

崩溃: 扩展:

有关它的使用和限制的额外信息，请务必阅读我在自述书中对MarkdownTOC插件的注释。