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

apm install markdown-toc

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

嗯…使用Markdown的标题!?

那就是:

#这相当于< h1 >

这相当于< h2>

这相当于< h3>

许多编辑器会向您展示TOC。您还可以为标题标记提供grep，并创建自己的标题标记。

希望有帮助!

--JF

对于Visual Studio Code用户来说，今天(2020年)使用的最佳选择是Markdown All in One插件(扩展)。

要安装它，启动VS Code快速打开(Control/⌘+P)，粘贴以下命令，并按enter。

ext install yzhang.markdown-all-in-one

要生成TOC，打开命令面板(Control/⌘+Shift+P)，并选择select Markdown:创建内容表选项。

---

另一个选择是Markdown TOC插件。

要安装它，启动VS Code快速打开(Control/⌘+P)，粘贴以下命令，并按enter。

ext install markdown-toc

要生成TOC，打开命令面板(Control/⌘+Shift+P)，并选择Markdown TOC:插入/更新选项或使用Control/⌘+MT。

如果使用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插件的注释。

对我来说，@Tum提出的解决方案对于2个层次的目录来说非常有效。然而，对于第3个关卡，这种方法却不起作用。它没有像前两层那样显示链接，而是显示纯文本3.5.1。[bla blabla](#blablabla) <br>代替。

我的解决方案是@Tum解决方案(非常简单)的补充，适用于需要3级或以上目录的人。

在第二层，一个简单的制表符将为您正确地完成缩进。但它不支持2个标签。相反，你必须使用一个标签，并添加尽可能多的&nbsp;根据你自己的需要来正确对齐第三层。

下面是一个使用4个关卡的例子(关卡越高，它就变得越糟糕):

# Table of Contents
1. [Title](#title) <br>
    1.1. [sub-title](#sub_title) <br>
    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;1.1.1. [sub-sub-title](#sub_sub_title)
    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;1.1.1.1. [sub-sub-sub-title](#sub_sub_sub_title)

# Title <a name="title"></a>
Heading 1

## Sub-Title <a name="sub_title"></a>
Heading 2

### Sub-Sub-Title <a name="sub_sub_title"></a>
Heading 3

#### Sub-Sub-Sub-Title <a name="sub_sub_sub_title"></a>
Heading 4

这将给出以下结果，其中目录表的每个元素都是到其相应部分的链接。还要注意<br>，以便添加新行，而不是在同一行上。

目录

标题 1.1. 字幕 1.1.1。Sub-Sub-Title                   1.1.1.1。Sub-Sub-Sub-Title

标题

标题1

字幕

标题2

Sub-Sub-Title

标题3

Sub-Sub-Sub-Title

标题4

在Gitlab上，marklab支持这个:[[_TOC_]