1. 程式人生 > >MarkDown生成目錄

MarkDown生成目錄

1.簡介

使用MarkDown寫技術文件,愈來愈受歡迎,然而在文件寫好準備增加目錄時,常常會遇到問題。本文旨在為大家生成目錄提供有效的方法,避免走彎路。

2.生成目錄的方法

通過各種搜尋得到了MarkDown生成目錄的方法有:

  • 直接使用[TOC];嘗試以後發現都未實現自己想要的效果
  • 使用各種工具;這麼簡單的功能需要那麼麻煩實現嗎
  • 使用錨點;該方法的確有效,但需要注意所用編輯器

以上三種,基本涵蓋了所有方法。誠然,以上三種都可以實現,但是各有缺陷,以及存在侷限性,下面分別對這三種方法進行論述,各位可以根據自己情況選擇。

  • 直接使用[TOC]
    優點:
    使用簡單,只需一行程式碼即可實現
    缺點:
    1.受限於MarkDown編輯器,在某些編輯器下可能不能被識別,如MacDown
    2.自定義程度太低,如果想自定義自己想要的目錄,貌似優點難了

  • 使用各種工具
    優點
    不受編輯器限制,可以實現目錄
    缺點
    需要學習工具的使用,投入時間過多

  • 使用錨點
    優點
    自定義程度較高,可以快速實現目錄
    缺點
    受限於MarkDown編輯工具,某些編輯器不支援,如MacDown;這裡推薦使用馬克飛象來進行編輯

3 .個人推薦

以上三種方法,都有嘗試,個人更偏向於使用馬克飛象編輯器+錨點實現目錄,當然也推薦各位嘗試。