markdown文件生成目錄的方式


markdown語法簡單好上手,在項目中很多文檔都是采用markdown語法完成的,以下介紹兩種在markdown文檔中自動生成目錄的方式。

一、有道自動生成

在文章開始地方輸入[toc],即可在對應位置插入目錄

[toc]

注意:凡是文章標題帶有#(1-6個)的都會被捕獲到目錄中。

二、npm 語法生成

全局安裝doctoc插件

npm i doctoc -g //install 簡寫 i

假如你的markdown文件在work/demo.md文件下,只需要cd work 切換到當前文件目錄下,執行doctoc demo.md文件,即可在文檔中自動生成目錄。

 
doctoc

三、兩種方式的優缺點

1.有道生成目錄

優點是:簡單快捷,

缺點是:直接生成文字目錄,沒有生成相應的目錄連接

2.npm doctoc生成目錄

優點:生成了相應的目錄連接(例如:文章段落一有地方要跳轉到段落二,這時候有目錄鏈接就很方便的完成跳轉了)

缺點:依賴npm


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM