github上如何爲markdown文件生成目錄

寫在前面

熟悉markdown都知道可以使用[TOC]自動生成markdown文件的標題目錄,比如在typora,vscode(需要插件)等本地編輯器中,或者在CSDN等網頁編輯器中,但是github卻不支持[TOC]標籤,至於爲什麼不支持感興趣的可以深入搜索,而相應的解決方法之一就是爲md文件自動生成適用於github的目錄。

網頁生成

有沒有這樣自動生成目錄的操作呢?答案是有的,其中之一就是在線的generator,比如GitHub Wiki TOC generator。但是經本人實測並不好用且麻煩。

使用toc工具

網頁生成的方法並不好用,使用toc工具,比如gh-md-toc這個神器,如何安裝可參考這篇博文快速生成Github README.md的目錄。安裝後在終端輸入命令就可以在終端裏生成目錄,但是也比較麻煩,因爲是在終端生成的,複製粘貼到md文件裏比較麻煩,還要注意格式對齊的問題。

最簡單的markdown插件

筆者目前瞭解到的最最最簡單的莫過於VSCode中的Markdown All in One
插件了,安裝後點開md文件,然後快捷鍵CTRL(CMD)+SHIFT+P,輸入Markdown All in One: Create Table of Contents回車即可,如下:
在這裏插入圖片描述
在這裏插入圖片描述
在這裏插入圖片描述

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章