Markdown目錄

一、什么是Markdown目錄？

Markdown（簡(jiǎn)稱(chēng)md）是一種輕量級(jí)標(biāo)記語(yǔ)言，它因其簡(jiǎn)潔、易讀、易編寫(xiě)的特點(diǎn)，在寫(xiě)作領(lǐng)域得到廣泛的應(yīng)用。而Markdown目錄則是指在md文檔中通過(guò)添加標(biāo)題（#）和縮進(jìn)來(lái)實(shí)現(xiàn)的目錄。

在md文檔中，要?jiǎng)?chuàng)建目錄只需要定義標(biāo)題，即使用#號(hào)來(lái)定義各級(jí)標(biāo)題，通過(guò)標(biāo)題的縮進(jìn)來(lái)對(duì)標(biāo)簽進(jìn)行歸類(lèi)。

Markdown目錄示例

# 第一級(jí)標(biāo)題
## 第二級(jí)標(biāo)題
### 第三級(jí)標(biāo)題
#### 第四級(jí)標(biāo)題

## 第二級(jí)標(biāo)題
### 第三級(jí)標(biāo)題
#### 第四級(jí)標(biāo)題
# 第一級(jí)標(biāo)題結(jié)束

如上所示，我們可以看到在md文檔中定義的各級(jí)標(biāo)題都會(huì)在目錄中顯示出來(lái)，在標(biāo)題后面加上錨點(diǎn)鏈接的格式，用戶(hù)可以通過(guò)點(diǎn)擊鏈接來(lái)快速跳轉(zhuǎn)到相應(yīng)的位置。

二、Markdown目錄的優(yōu)點(diǎn)

1、結(jié)構(gòu)清晰：通過(guò)添加目錄來(lái)進(jìn)行版本控制，整篇文檔的結(jié)構(gòu)性更清晰，對(duì)于用戶(hù)而言，可以更加快速的定位自己所需要的內(nèi)容。

2、閱讀便捷：使用Markdown目錄生成的文檔可以輕松快速的尋找所需內(nèi)容，省去了翻找額外內(nèi)容的時(shí)間，提高了閱讀體驗(yàn)。

3、易于維護(hù)：目錄與文檔內(nèi)容分離，使得文章的排版和編輯更加方便，修改后目錄自動(dòng)更新。

三、如何使用Markdown目錄

要讓文檔中自動(dòng)生成目錄，只需要在首部添加一小段內(nèi)容即可，如下所示：

具有自動(dòng)生成目錄的Markdown文檔

[TOC]

# 第一部分
## 第一章
### 第一節(jié)
### 第二節(jié)
## 第二章
### 第一節(jié)
### 第二節(jié)

# 第二部分
## 第一章
### 第一節(jié)
### 第二節(jié)
## 第二章
### 第一節(jié)
### 第二節(jié)

使用[TOC]標(biāo)簽就可以實(shí)現(xiàn)自動(dòng)生成目錄了。

四、Markdown目錄在Github中的使用

Github是程序員必備的一個(gè)社交平臺(tái)，它支持md格式文件的在線(xiàn)查看、分享和編輯。而在Github中，用戶(hù)可以通過(guò)展開(kāi)目錄快速定位內(nèi)容，這需要在Github存庫(kù)時(shí)生成一個(gè)markdown渲染文件，來(lái)顯示其中的目錄。

在Github中，Markdown目錄的添加與正常的Markdown語(yǔ)法相同，只需要在md文件中添加標(biāo)題就行。如果一次性添加多個(gè)目錄，那么可以使用循環(huán)加列表的方式將多個(gè)目錄集中在一起：

Github中的markdown目錄示例

- [第一章](#第一章)
  - [第一節(jié)](#第一節(jié))
  - [第二節(jié)](#第二節(jié))
- [第二章](#第二章)
  - [第一節(jié)](#第一節(jié)-1)
  - [第二節(jié)](#第二節(jié)-1)

# 第一章
## 第一節(jié)
### 第一小節(jié)
### 第二小節(jié)
## 第二節(jié)
### 第一小節(jié)
### 第二小節(jié)

# 第二章
## 第一節(jié)
### 第一小節(jié)
### 第二小節(jié)
## 第二節(jié)
### 第一小節(jié)
### 第二小節(jié)

在Github中，目錄是由前端樣式生成的。用戶(hù)只需要通過(guò)#來(lái)定義標(biāo)題，Github前端渲染就可以自動(dòng)識(shí)別標(biāo)題，生成具有層級(jí)結(jié)構(gòu)的目錄結(jié)構(gòu)并實(shí)現(xiàn)跳轉(zhuǎn)。