腳注
腳注是 Markdown 的一種擴展功能,可以為文檔添加引用說明或補充信息,讓讀者在不打斷閱讀流程的情況下查看額外的解釋。
基本語法
添加腳注
在 Markdown 中創建腳注包含兩個部分:腳注標記和腳注內容。
markdown
這是一段包含腳注的文本[^1]。
[^1]: 這是腳注的內容。
渲染效果:
這是一段包含腳注的文本^1。
多個腳注
markdown
Markdown 是一種輕量級標記語言[^1],由 John Gruber 創建[^2],現在被廣泛應用於寫作領域[^3]。
[^1]: Markdown 使用簡單的語法來實現文本格式化。
[^2]: John Gruber 於 2004 年創建了 Markdown。
[^3]: 許多平台如 GitHub、Stack Overflow 和博客平台都支持 Markdown。
渲染效果:
Markdown 是一種輕量級標記語言[^2],由 John Gruber 創建[^3],現在被廣泛應用於寫作領域[^4]。
[^2]: Markdown 使用簡單的語法來實現文本格式化。 [^3]: John Gruber 於 2004 年創建了 Markdown。 [^4]: 許多平台如 GitHub、Stack Overflow 和博客平台都支持 Markdown。
高級用法
腳注標識符
腳注標識符可以是數字或單詞,但不能包含空格或制表符。
markdown
這裡有一個普通腳注[^1]和一個帶標識符的腳注[^note]。
[^1]: 這是普通腳注。
[^note]: 這是一個帶標識符的腳注。
渲染效果:
多段落腳注
腳注內容可以包含多個段落或其他元素,需要保持縮進。
markdown
這是一個包含多段落的腳注[^multipara]。
[^multipara]: 這是腳注的第一段。
這是腳注的第二段。縮進至少四個空格或一個制表符。
> 腳注中還可以包含引用塊。
- 也可以包含列表
- 有序或無序列表都可以
渲染效果:
這是一個包含多段落的腳注^multipara。
這是腳注的第二段。縮進至少四個空格或一個制表符。
> 腳注中還可以包含引用塊。
- 也可以包含列表
- 有序或無序列表都可以
行內腳注
某些 Markdown 實現支持行內腳注語法,但這不是標准 Markdown 的一部分。
markdown
這是一個行內腳注^[直接在文本中添加腳注內容而非在文檔末尾]。
渲染效果(在支持的平台上):
這是一個行內腳注^[直接在文本中添加腳注內容而非在文檔末尾]。
兼容性和實現差異
不同平台支持情況
平台/工具 | 標准腳注 | 行內腳注 | 多段落腳注 |
---|---|---|---|
GitHub Markdown | ✅ | ❌ | ✅ |
GitLab Markdown | ✅ | ✅ | ✅ |
Jekyll(kramdown) | ✅ | ✅ | ✅ |
Hugo | ✅ | ✅ | ✅ |
CommonMark | ❌ | ❌ | ❌ |
VitePress | ✅ | ✅ | ✅ |
Pandoc | ✅ | ✅ | ✅ |
HTML 輸出格式
大多數 Markdown 處理器會將腳注轉換為具有鏈接和返回箭頭的 HTML:
html
<!-- 腳注引用 -->
<p>這是一段包含腳注的文本<sup id="fnref:1"><a href="#fn:1" class="footnote-ref">1</a></sup>。</p>
<!-- 腳注內容(通常位於文檔末尾) -->
<div class="footnotes">
<hr>
<ol>
<li id="fn:1">
<p>這是腳注的內容。<a href="#fnref:1" class="footnote-backref">↩</a></p>
</li>
</ol>
</div>
使用建議與最佳實踐
何時使用腳注
腳注適用於以下情況:
- 引用來源:引用研究論文、書籍或其他參考資料
- 補充解釋:提供額外信息而不打斷主要內容
- 延伸閱讀:為感興趣的讀者提供更多資源
- 術語解釋:解釋專業術語或縮寫
腳注排版建議
markdown
✅ 推薦做法:
1. **腳注內容放在末尾**:將所有腳注定義放在文檔末尾,便於維護
2. **保持一致性**:使用一致的腳注標記方式(數字或有意義的標識符)
3. **適度使用**:過多的腳注會分散讀者注意力
4. **提供有意義的內容**:腳注應該增加實際價值,而不僅是重復正文
❌ 避免做法:
1. 在一個句子中使用多個腳注
2. 使用腳注來展示核心信息
3. 腳注中放置過長的內容
4. 腳注嵌套腳注
長文檔中的腳注
對於很長的文檔,可以將腳注按章節分組:
markdown
# 第一章
這是第一章的內容,包含一個腳注[^1-1]。
[^1-1]: 第一章的第一個腳注。
# 第二章
這是第二章的內容,包含另一個腳注[^2-1]。
[^2-1]: 第二章的第一個腳注。
常見問題解決
腳注不顯示
如果您的腳注沒有正確顯示:
- 確保腳注標識符和腳注定義完全匹配(包括大小寫)
- 驗證腳注定義是否有正確的格式(冒號後需要空格)
- 檢查您的 Markdown 處理器是否支持腳注語法
- 嘗試在腳注定義前後留出空行
腳注編號混亂
一些處理器會自動重新編號腳注,即使您使用了自定義標識符。這是預期行為,最終顯示通常是連續的數字。
移動設備上的可用性
在移動設備上,腳注鏈接可能較小,難以點擊。使用支持懸浮預覽腳注的閱讀器可以改善這一問題。
相關語法
練習與應用
- 創建一個包含至少三個不同腳注的短文章
- 嘗試創建一個包含多段落內容的腳注
- 在學術或技術文章中使用腳注引用參考資料
腳注是增強 Markdown 文檔專業性和可信度的重要工具。它們讓您可以在不打斷主要內容流程的情況下提供額外信息,使文檔更加完整和權威。