Table of Contents
根據每篇文章的標題產生目錄,並帶有跳轉連結。撰寫時無需插入任何內容。
外掛
Table of Contents
根據每篇文章的標題產生目錄,並帶有跳轉連結。撰寫時無需插入任何內容。
安裝
兩個步驟
- 在 EmDash 管理後台開啟 Registry,搜尋 Table of Contents,然後點擊 Install。它不需要任何權限。
- 在左側選單中開啟 Table of Contents,進入 Setup 分頁,把它顯示的簡短程式碼區塊貼到基礎版面配置的 head 中,通常是
src/layouts/Base.astro。如果你的網站是別人建置的,請把這段程式碼區塊寄給對方。
這樣就完成了。每篇有足夠多標題的文章或頁面都會獲得目錄,作者無需做任何事。Settings 分頁可設定標題、哪些標題層級計入、清單的位置,以及是否預設收合。
若想自己指定確切位置,請在文章範本中放入 “。若要排除某個標題,請給它加上 data-toc-skip。
常見問題
這個外掛有什麼作用?
它在讀者的瀏覽器中讀取文章或頁面的標題,並在頂部顯示一份跳轉連結清單。點擊某一行會捲動到對應章節,閱讀時目前章節會被標記,網址列會取得該章節的連結,便於分享。作者無需插入任何內容。
使用哪些標題?
由你選擇:僅 H2、H2 和 H3,或 H2 到 H4。H3 項目位於其所屬 H2 之下。H1 從不使用,因為那是文章標題。
我的標題沒有 id。它還能用嗎?
可以。當標題沒有 id 時,外掛會根據其文字為每個標題產生一個 id,因此連結在任何佈景主題上都能正常運作。
我可以在短文章上停用它嗎?
只有當頁面至少有你設定的標題數量(預設是三個)時,才會顯示該清單。對於網站的某一整個區域,請使用 Show on 並填入網址開頭,例如 /posts。
它放在哪裡?
放在第一個標題之前、第一段之後,或內容區域的頂部。如果你想把它放在別處,請在範本中放一個帶有 data-toc 的空元素,它就會出現在那裡。
跳轉之後,標題被我的固定選單遮住了
請把 Settings 中的 Sticky header height 設定為你的選單列高度(以像素為單位)。
它會蒐集任何內容嗎?
不會。該外掛無法存取你的內容,也不會向你的網站之外發出請求。唯一的呼叫是你的網站取得它自己的設定。
它會拖慢網站嗎?
該指令碼約 5 KB,在頁面就緒後載入,並快取一分鐘。不會從其他伺服器載入任何內容。
更新日誌
0.1.0
- 首次發布。根據每篇文章或頁面的標題產生目錄,帶有跳轉連結、平滑捲動,並標記目前章節。
- 設定:標題、計入的標題層級、最少標題數量、位置、編號、預設收合、在所有頁面或以某個路徑開頭的網址上顯示、固定頁首高度、內容區域。
- 使用
data-toc自行放置。使用data-toc-skip排除某個標題。 - Setup 分頁會顯示網站是否正在載入目錄。