我开始使用markdown做笔记。

我使用标记来查看我的降价记录及其美观。

但是随着我的笔记越来越长，我发现很难找到想要的东西。

我知道markdown可以创建表，但是它能够创建目录，跳到各节或在markdown中定义页面节吗？

另外，是否有降价阅读器/编辑器可以做到这一点。搜索也将是一个很好的功能。

简而言之，我想使它成为我很棒的笔记工具和功能，就像写书等一样。

MultiMarkdown Composer似乎确实会生成目录表，以在编辑时提供帮助。

可能还有一个或另一个库可以生成TOC：请参阅Python Markdown TOC Extension。

您可以尝试一下。

# Table of Contents
1. [Example](#example)
2. [Example2](#example2)
3. [Third Example](#third-example)
4. [Fourth Example](#fourth-examplehttpwwwfourthexamplecom)


## Example
## Example2
## Third Example
## [Fourth Example](http://www.fourthexample.com) 

这是一个有用的方法。应该在任何MarkDown编辑器中产生可点击的引用。

# Table of contents
1. [Introduction](#introduction)
2. [Some paragraph](#paragraph1)
    1. [Sub paragraph](#subparagraph1)
3. [Another paragraph](#paragraph2)

## This is the introduction <a name="introduction"></a>
Some introduction text, formatted in heading 2 style

## Some paragraph <a name="paragraph1"></a>
The first paragraph text

### Sub paragraph <a name="subparagraph1"></a>
This is a sub paragraph, formatted in heading 3 style

## Another paragraph <a name="paragraph2"></a>
The second paragraph text

产生：

目录

1. 介绍
2. 一些段落
   1. 子段落
3. 另一段

这是介绍

一些介绍文字，格式为标题2的样式

一些段落

第一段文字

子段落

这是一个子段落，标题3格式

另一段

第二段文字

对于Visual Studio Code用户，一个好主意是使用Markdown TOC插件。

要安装它，请启动VS Code快速打开（Control/⌘+ P），粘贴以下命令，然后按Enter。

ext install markdown-toc

要生成目录，请打开命令选项板（Control/⌘+ Shift+ P）并选择Markdown TOC:Insert/Update option或使用Control/⌘+ MT。

您可以尝试使用此ruby脚本从markdown文件生成TOC。

 #!/usr/bin/env ruby

require 'uri'

fileName = ARGV[0]
fileName = "README.md" if !fileName

File.open(fileName, 'r') do |f|
  inside_code_snippet = false
  f.each_line do |line|
    forbidden_words = ['Table of contents', 'define', 'pragma']
    inside_code_snippet = !inside_code_snippet if line.start_with?('```')
    next if !line.start_with?("#") || forbidden_words.any? { |w| line =~ /#{w}/ } || inside_code_snippet

    title = line.gsub("#", "").strip
    href = URI::encode title.gsub(" ", "-").downcase
    puts "  " * (line.count("#")-1) + "* [#{title}](\##{href})"
  end
end

在减价文档中有两种创建目录（摘要）的方法。

1.手动

# My Table of content
- [Section 1](#id-section1)
- [Section 2](#id-section2)

<div id='id-section1'/>
## Section 1
<div id='id-section2'/>
## Section 2

2.以编程方式

您可以使用，例如，对于您汇总生成一个脚本，看看我的项目在GitHub上- summarizeMD -

我也尝试了其他脚本/ npm模块（例如doctoc），但是没有人使用工作锚来重现TOC。

# Table of Contents
1. [Example](#example)
2. [Example2](#example2)
3. [Third Example](#third-example)

## Example [](#){name=example}
## Example2 [](#){name=example2}
## [Third Example](#){name=third-example}

如果您额外使用markdown，请别忘了可以为链接，标题，代码围栏和图像添加特殊属性。
https://michelf.ca/projects/php-markdown/extra/#spe-attr

由不同的Markdown解析器生成的Anchor标签不是偶数。

如果您正在使用Markdown解析器GFM（GitHub Flavored Markdown）或Redcarpet，我编写了一个Vim插件来处理目录。

特征

1. 生成Markdown文件的目录。

   支持的Markdown解析器：

   • GFM（GitHub风味Markdown）
   • 红地毯

2. 更新现有目录。

3. 保存时自动更新现有目录。

屏幕截图

用法

生成目录

将光标移到要追加目录的行，然后在适合您的位置下面键入命令。光标进入目录后，该命令将生成标题。

1. :GenTocGFM

   以GFM链接样式生成目录。

   该命令适用于GitHub存储库中的Markdown文件，例如README.md，以及适用于GitBook的Markdown文件。

2. :GenTocRedcarpet

   以Redcarpet链接样式生成目录。

   该命令适用于Jekyll或其他使用Redcarpet作为其Markdown解析器的地方。

   您可以在此处查看以了解GFM和Redcarpet样式目录链接之间的区别。

手动更新现有目录

通常，您不需要这样做，默认情况下，现有目录将在保存时自动更新。如果要手动执行，只需使用:UpdateToc命令。

下载和文件

https://github.com/mzlogin/vim-markdown-toc

你也可以使用pandoc，在“瑞士军刀”转换“一个标记格式转换成另一种”。如果提供--toc参数，它将自动在输出文档中生成目录。

提示：如果要在html输出中显示目录，则还需要提供-s生成一个独立文档的目录。

shell命令行示例：

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

为了我们这些人README.md在Atom中制作文件的好处（我如何找到此线程）：

apm install markdown-toc

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

如果要使用javascript / node.js工具，请查看markdown-toc。

您可以使用此bash单线生成它。假设您的markdown文件称为FILE.md。

echo "## Contents" ; echo ; 
cat FILE.md | grep '^## ' | grep -v Contents | sed 's/^## //' | 
  while read -r title ; do 
    link=$(echo $title | tr 'A-Z ' 'a-z-') ; 
    echo "- [$title](#$link)" ; 
    done

我刚刚对扩展进行了编码，该扩展python-markdown使用其解析器来检索标题，并以Markdown格式输出带有本地链接的无序列表，生成一个TOC。该文件是

• md_toc.py（是md_toc.py）

...，并且应将其放置在markdown/extensions/markdown安装目录中。然后，您要做的就是键入<a>带有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)

...然后您可以将此目录粘贴回markdown文档中（或在文本编辑器中使用快捷方式，该快捷方式将调用当前打开的文档中的脚本，然后将生成的目录插入到同一文档中）。

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

如其他答案所述，有多种方法可以自动生成目录。大多数都是开源软件，可以适应您的需求。

但是，我所缺少的是使用Markdown提供的有限选项的目录格式，其外观具有视觉吸引力。我们提出以下内容：

码

## Content

**[1. Markdown](#heading--1)**

  * [1.1. Markdown formatting cheatsheet](#heading--1-1)
  * [1.2. Markdown formatting details](#heading--1-2)

**[2. BBCode formatting](#heading--2)**

  * [2.1. Basic text formatting](#heading--2-1)

      * [2.1.1. Not so basic text formatting](#heading--2-1-1)

  * [2.2. Lists, Images, Code](#heading--2-2)
  * [2.3. Special features](#heading--2-3)

----

在文档内部，您将放置目标子部件标记，如下所示：

<div id="heading--1-1"/>
### 1.1. Markdown formatting cheatsheet

根据您在哪里使用Markdown以及如何使用Markdown，以下内容也应该起作用，并提供美观的Markdown代码：

### 1.1. Markdown formatting cheatsheet <a name="heading--1-1"/>

渲染示例

内容

1.降价

• 1.1。Markdown格式备忘单
• 1.2。降价格式详细信息

2. BBCode格式

• 2.1。基本文字格式

  • 2.1.1。不太基本的文本格式

• 2.2。清单，图片，代码

• 2.3。特殊功能

---

优点

• 您可以根据需要添加任意数量的章节和子章节。在目录中，这些将显示为更深层的嵌套无序列表。

• 不使用有序列表。这些将创建缩进，不链接数字，并且不能用于创建十进制分类编号（如“ 1.1”）。

• 第一层不使用列表。在这里，可以使用无序列表，但不是必须的：缩进和项目符号只会增加视觉混乱，并且此处没有任何功能，因此我们根本不使用列表作为第一个ToC级别。

• 视觉上用粗体突出显示目录中的第一部分。

• 在浏览器的URL栏中看起来“漂亮”的简短，有意义的子部分标记，例如#heading--1-1包含实际标题的已转换部分的标记，而不是标记。

• 该代码将H2标题（## …）用于部分，将H3标题（### …）用于子标题等。这使源代码更易于阅读，因为## …与以H1标题开头的部分相比，滚动时提供了更强的视觉提示（# …）。当您使用H1标题作为文档标题本身时，它在逻辑上仍然保持一致。

• 最后，我们添加了一个很好的水平规则，以将目录与实际内容分开。

有关此技术以及我们如何在论坛软件Discourse中使用它的更多信息，请参见此处。

我编写了一个Python脚本，用于解析markdown文件并输出目录作为markdown列表：md-to-toc

与我发现的其他脚本不同，md-to-toc正确支持重复的标题。它还不需要互联网连接，因此它可用于任何md文件，而不仅限于公共仓库中可用的文件。

在Visual Studio Code（VSCode）中，可以使用扩展Markdown All in One。

安装完成后，请按照以下步骤操作：

1. 按CTRL+ SHIFT+P
2. 选择Markdown：创建目录

我刚开始做同样的事情（在Markdown中记笔记）。我将Sublime Text 2与MarkdownPreview插件一起使用。内置的markdown解析器支持[TOC]。

Typora通过添加到文档中来生成目录[TOC]。

在Gitlab上，markdown支持以下功能： [[_TOC_]]

只需将文本编辑器与插件配合使用即可。

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

其他编辑器也有类似的插件，因此受欢迎的列表如下：

• Emacs：markdown-toc
• Vim：markdown-toc
• 原子：markdown-toc
• VSCode：markdown-toc

基于albertodebortoli的答案创建了带有附加检查和标点符号替换功能。

# @fn       def generate_table_of_contents markdown # {{{
# @brief    Generates table of contents for given markdown text
#
# @param    [String]  markdown Markdown string e.g. File.read('README.md')
#
# @return   [String]  Table of content in markdown format.
#
def generate_table_of_contents markdown
  table_of_contents = ""
  i_section = 0
  # to track markdown code sections, because e.g. ruby comments also start with #
  inside_code_section = false
  markdown.each_line do |line|
    inside_code_section = !inside_code_section if line.start_with?('```')

    forbidden_words = ['Table of contents', 'define', 'pragma']
    next if !line.start_with?('#') || inside_code_section || forbidden_words.any? { |w| line =~ /#{w}/ }

    title = line.gsub("#", "").strip
    href = title.gsub(/(^[!.?:\(\)]+|[!.?:\(\)]+$)/, '').gsub(/[!.,?:; \(\)-]+/, "-").downcase

    bullet = line.count("#") > 1 ? " *" : "#{i_section += 1}."
    table_of_contents << "  " * (line.count("#") - 1) + "#{bullet} [#{title}](\##{href})\n"
  end
  table_of_contents
end

MultiMarkdown 4.7具有一个{{TOC}}宏，用于插入目录。

对我来说，@ Tum提出的解决方案就像一个魅力，适用于具有2个级别的目录。但是，对于第3级，它不起作用。它没有显示前两个级别的链接，而是显示纯文本3.5.1. [bla bla bla](#blablabla) <br>。

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

在第二级，一个简单的选项卡将为您正确地缩进。但它不支持2个标签。相反，您必须使用一个标签并添加尽可能多的标签 自己所需的数量，以便正确对齐第三级。

这是一个使用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.1。子标题
                    1.1.1.1。子-子-子标题

标题

标题1

字幕

标题2

子标题

标题3

标题4

根据您的工作流程，您可能需要考虑简化

这是原始目录（http://strapdownjs.com）的一个分支，它添加了目录的生成。

如果您不愿意编写html文件，则回购文件上有一个apache配置文件（可能尚未正确更新），可以即时打包纯净的markdown。

我不确定降价的官方文件是什么。交叉引用可以只写在方括号中[Heading]，也可以用空括号括起来[Heading][]。

两者都可以使用pandoc。因此，我创建了一个快速的bash脚本，它将md文件中的$ TOC替换为其TOC。（您将需要envsubst，这可能不是您发行版的一部分）

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

如果碰巧使用Eclipse，则可以使用Ctrl+ O（概述）快捷方式，这将显示与目录等效的内容，并允许在节标题中进行搜索（自动完成）。

您也可以打开“大纲”视图（“窗口”->“显示视图”->“大纲”），但没有自动完成搜索。

使用toc.py是一个很小的python脚本，它会为您的markdown生成目录。

用法：

• 在Markdown文件中，添加<toc>目录的放置位置。
• $python toc.py README.md（使用markdown文件名而不是README.md）

干杯!

我使用了https://github.com/ekalinin/github-markdown-toc，它提供了一个命令行实用程序，可从markdown文档自动生成目录。

没有插件，宏或其他依赖项。安装实用程序后，只需将实用程序的输出粘贴到文档中您想要目录的位置。使用非常简单。

$ cat README.md | ./gh-md-toc -

如果要将Markdown文件显示在bitbucket.org的存储库中，则应将其添加[TOC]到想要目录的位置。然后它将自动生成。更多信息在这里：

https://confluence.atlassian.com/bitbucket/add-a-table-of-contents-to-a-wiki-221451163.html

有一个名为mdtoc.rb的Ruby脚本可以自动生成GFM 降价目录，它与此处发布的其他一些脚本类似但略有不同。

给定一个输入Markdown文件，例如：

# Lorem Ipsum

Lorem ipsum dolor sit amet, mei alienum adipiscing te, has no possit delicata. Te nominavi suavitate sed, quis alia cum no, has an malis dictas explicari. At mel nonumes eloquentiam, eos ea dicat nullam. Sed eirmod gubergren scripserit ne, mei timeam nonumes te. Qui ut tale sonet consul, vix integre oportere an. Duis ullum at ius.

## Et cum

Et cum affert dolorem habemus. Sale malis at mel. Te pri copiosae hendrerit. Cu nec agam iracundia necessitatibus, tibique corpora adipisci qui cu. Et vix causae consetetur deterruisset, ius ea inermis quaerendum.

### His ut

His ut feugait consectetuer, id mollis nominati has, in usu insolens tractatos. Nemore viderer torquatos qui ei, corpora adipiscing ex nec. Debet vivendum ne nec, ipsum zril choro ex sed. Doming probatus euripidis vim cu, habeo apeirian et nec. Ludus pertinacia an pro, in accusam menandri reformidans nam, sed in tantas semper impedit.

### Doctus voluptua

Doctus voluptua his eu, cu ius mazim invidunt incorrupte. Ad maiorum sensibus mea. Eius posse sonet no vim, te paulo postulant salutatus ius, augue persequeris eum cu. Pro omnesque salutandi evertitur ea, an mea fugit gloriatur. Pro ne menandri intellegam, in vis clita recusabo sensibus. Usu atqui scaevola an.

## Id scripta

Id scripta alterum pri, nam audiam labitur reprehendunt at. No alia putent est. Eos diam bonorum oportere ad. Sit ad admodum constituto, vide democritum id eum. Ex singulis laboramus vis, ius no minim libris deleniti, euismod sadipscing vix id.

它生成以下目录：

$ mdtoc.rb FILE.md 
#### Table of contents

1. [Et cum](#et-cum)
    * [His ut](#his-ut)
    * [Doctus voluptua](#doctus-voluptua)
2. [Id scripta](#id-scripta)

另请参阅我关于此主题的博客文章。