一、什么是Markdown目錄?
Markdown(簡稱md)是一種輕量級標(biāo)記語言,它因其簡潔、易讀、易編寫的特點,在寫作領(lǐng)域得到廣泛的應(yīng)用。而Markdown目錄則是指在md文檔中通過添加標(biāo)題(#)和縮進(jìn)來實現(xiàn)的目錄。
在md文檔中,要創(chuàng)建目錄只需要定義標(biāo)題,即使用#號來定義各級標(biāo)題,通過標(biāo)題的縮進(jìn)來對標(biāo)簽進(jìn)行歸類。
Markdown目錄示例
# 第一級標(biāo)題 ## 第二級標(biāo)題 ### 第三級標(biāo)題 #### 第四級標(biāo)題 ## 第二級標(biāo)題 ### 第三級標(biāo)題 #### 第四級標(biāo)題 # 第一級標(biāo)題結(jié)束
如上所示,我們可以看到在md文檔中定義的各級標(biāo)題都會在目錄中顯示出來,在標(biāo)題后面加上錨點鏈接的格式,用戶可以通過點擊鏈接來快速跳轉(zhuǎn)到相應(yīng)的位置。
二、Markdown目錄的優(yōu)點
1、結(jié)構(gòu)清晰:通過添加目錄來進(jìn)行版本控制,整篇文檔的結(jié)構(gòu)性更清晰,對于用戶而言,可以更加快速的定位自己所需要的內(nèi)容。
2、閱讀便捷:使用Markdown目錄生成的文檔可以輕松快速的尋找所需內(nèi)容,省去了翻找額外內(nèi)容的時間,提高了閱讀體驗。
3、易于維護(hù):目錄與文檔內(nèi)容分離,使得文章的排版和編輯更加方便,修改后目錄自動更新。
三、如何使用Markdown目錄
要讓文檔中自動生成目錄,只需要在首部添加一小段內(nèi)容即可,如下所示:
具有自動生成目錄的Markdown文檔
[TOC] # 第一部分 ## 第一章 ### 第一節(jié) ### 第二節(jié) ## 第二章 ### 第一節(jié) ### 第二節(jié) # 第二部分 ## 第一章 ### 第一節(jié) ### 第二節(jié) ## 第二章 ### 第一節(jié) ### 第二節(jié)
使用[TOC]標(biāo)簽就可以實現(xiàn)自動生成目錄了。
四、Markdown目錄在Github中的使用
Github是程序員必備的一個社交平臺,它支持md格式文件的在線查看、分享和編輯。而在Github中,用戶可以通過展開目錄快速定位內(nèi)容,這需要在Github存庫時生成一個markdown渲染文件,來顯示其中的目錄。
在Github中,Markdown目錄的添加與正常的Markdown語法相同,只需要在md文件中添加標(biāo)題就行。如果一次性添加多個目錄,那么可以使用循環(huán)加列表的方式將多個目錄集中在一起:
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中,目錄是由前端樣式生成的。用戶只需要通過#來定義標(biāo)題,Github前端渲染就可以自動識別標(biāo)題,生成具有層級結(jié)構(gòu)的目錄結(jié)構(gòu)并實現(xiàn)跳轉(zhuǎn)。