Markdown根据标题生成TOC

在Markdown中,可以使用Table of Contents(目录)功能自动生成文章或文档的内容列表,以及页面内部所有标题 (H1, H2, H3, H4, H5, H6) 的列表。有多种方法可以创建Markdown结构的目录,下面演示其中两个:

  1. 包含[[toc]]指令

某些编辑器扩展支持[[toc]]指令,并用它来代替编写的实际目录列表项。

# Table of Contents
[[toc]]

# 第一章 
## 1.1 表示式
## 1.2 函数

# 第二章
## 2.1 代码实现
### 2.1.1 方法 X
### 2.1.2 方法 Y
## 2.2 测试
### 2.2.1 功能测试
### 2.2.2 性能测试

# 参考

在上面的markdown代码开头添加了 [[toc]] 指令,这会让Markdown转换器自动处理成符合H1到H6的标题级别列表。具体使用效果如下:

Table of Contents

[[toc]]

第一章

1.1 表示式

1.2 函数

第二章

2.1 代码实现

2.1.1 方法 X

2.1.2 方法 Y

2.2 测试

2.2.1 功能测试

2.2.2 性能测试

参考

  1. 使用“Markdown-TOC”生成器插件。

这种方法需要借助第三方工具,如 markdown-toc 生成器插件。此外,在很多编辑器和在线服务的插件中也可能提供了类似的功能。下面以 VS Code 编辑器中 markdownlint 插件为例:

1)安装 markdown-toc generator 插件。安装后按 Ctrl/Cmd + Shift + P 执行 “Markdown TOC:Insert Table of Contents” 命令即可自动生成目录。

2)在markdown文档开始位置添加 [TOC] 标记(注意大小写)。

示例如下:

# My Article

[TOC]

## Section One

### Sub-Section One

## Section Two

效果如下:

My Article

[TOC]

Section One

Sub-Section One

Section Two

注: 不同的Markdown编辑器,标记语言的规则略有差异。如果你在使用GitHub、Jekyll、GitLab等博客平台或GitHub备份库,则可以通过其他方法创建 Markdown 文件结构的目录。

作者

Nick

发布于

2023-06-15

更新于

2023-10-21

许可协议

评论