跳轉至

註腳(Footnotes)

註腳可以替某個詞、片語或句子補充說明,而不會打斷文章的流暢度。Zensical 可以定義、引用並在頁面底部渲染註腳。

zensical.toml 設定

[project.markdown_extensions]
footnotes = {}

註腳提示氣泡

想讓讀者不用跳到頁面底部,直接在原地看到註腳內容,可以啟用:

[project.theme]
features = [
  "content.footnote.tooltips",
]

啟用後,把滑鼠移到(或用鍵盤聚焦)註腳編號上,就會浮出提示氣泡。本教學網站已經啟用。

加入註腳引用

註腳引用用方括號包起來,以 ^ 開頭,後面接任意識別字:

原始程式

Zensical 是靜態網站產生器[^1],由 Material for MkDocs 的團隊開發[^team]。

輸出結果

Zensical 是靜態網站產生器1,由 Material for MkDocs 的團隊開發2

撰寫註腳內容

註腳內容用相同的識別字宣告,可以放在文件的任何位置,但一定會被渲染在頁面底部,而且會自動加上「返回」連結。

單行註腳

[^1]: 靜態網站產生器會把 Markdown 轉成 HTML 檔案。

多行註腳:內容換行後,每行縮排四個空格:

[^team]:
    Material for MkDocs 是最受歡迎的 MkDocs 佈景主題,
    Zensical 由同一個團隊打造。

    這裡也可以有第二個段落。

總結

項目 語法
引用 文字[^識別字]
單行內容 [^識別字]: 說明
多行內容 [^識別字]: 換行,內容縮排四個空格
提示氣泡 content.footnote.tooltips

檢查註腳是否有問題

未定義或重複的註腳,可以用連結驗證的相關檢查抓出來。

參考資料


  1. 靜態網站產生器會把 Markdown 轉成 HTML 檔案。 

  2. Material for MkDocs 是最受歡迎的 MkDocs 佈景主題, Zensical 由同一個團隊打造。

    這裡也可以有第二個段落。