Markdown 腳注尾注
1. 前言
腳注和尾注都是對(duì)文章的補(bǔ)充說(shuō)明。
腳注通常與被注釋內(nèi)容出現(xiàn)在同一頁(yè),并位于該頁(yè)面的最下方,一般用來(lái)解釋專有名詞、數(shù)據(jù)來(lái)源等。
尾注通常出現(xiàn)在文章的最后一頁(yè),寫在文章全部正文之后,一般用來(lái)列明引用的文章列表等。
環(huán)境說(shuō)明:
考慮到 Markdown 工具之間的不兼容,有的內(nèi)容直接從頁(yè)面復(fù)制粘貼到本地不會(huì)正常顯示,大家學(xué)習(xí)時(shí)自己動(dòng)手寫是肯定沒問題的。本節(jié)所有實(shí)例代碼及演示效果均使用 Typora 工具完成。
本節(jié)所有渲染后效果截圖均為 Typora 導(dǎo)出成 HTML 后的顯示效果。
2. 語(yǔ)法詳解
2.1 腳注、尾注的聲明
2.1.1 添加引用的描述
要增加腳注(尾注),首先需要在文章的適當(dāng)位置增加引用的描述,形如:[^引用ID]: 說(shuō)明文字
。
實(shí)例 1:
腳注的聲明。
[^footnote]: 此處是 **腳注** 的 *文本內(nèi)容*。
注意,此步完成后,不會(huì)有渲染的內(nèi)容輸出,必須將引用添加到內(nèi)容中才有顯示。
2.1.2 引用部位添加引用注釋
在需要增加引用標(biāo)記的內(nèi)容后面增加 [^引用ID]
。
實(shí)例 2:
完整的腳注。
這里有一個(gè)腳注[^腳注ID1]。
這里有一個(gè)腳注[^腳注ID2]。
[^腳注ID1]: 此處是 **腳注** 的 *文本內(nèi)容*。
[^腳注ID2]: 此處是 **腳注** 的 *文本內(nèi)容*。
該內(nèi)容會(huì)被渲染成:
可以看到腳注的標(biāo)號(hào)會(huì)自動(dòng)編號(hào)。
其 Html 代碼為:
<p>這里有一個(gè)腳注<sup class="md-footnote"><a href="#dfref-footnote-1" name="ref-footnote-1">1</a></sup>。</p>
<p>這里有一個(gè)腳注<sup class="md-footnote"><a href="#dfref-footnote-2" name="ref-footnote-2">2</a></sup>。</p>
<div class="footnotes-area">
<hr />
<div class="footnote-line">
<span class="md-fn-count">1</span> 此處是
<strong>腳注</strong> 的
<em>文本內(nèi)容</em>。
<a name="dfref-footnote-1" href="#ref-footnote-1" title="回到文檔" class="reversefootnote">?</a>
</div>
<div class="footnote-line">
<span class="md-fn-count">2</span> 此處是
<strong>腳注</strong> 的
<em>文本內(nèi)容</em>。
<a name="dfref-footnote-2" href="#ref-footnote-2" title="回到文檔" class="reversefootnote">?</a>
</div>
</div>
在 Markdown 中,尾注和腳注的聲明方式是一樣的,區(qū)別在于是否把引用的描述部分寫到了文章的最末尾。由于 Markdown 在一些特定渲染輸出的情況下(比如:PDF)才有分頁(yè)的概念,所以我們優(yōu)先采用尾注的形式,也就是將注釋內(nèi)容寫到文章末尾。
3. 使用場(chǎng)景及實(shí)例
實(shí)例 4:
實(shí)現(xiàn)百度文庫(kù)效果的《出師表》。
**《出師表》(節(jié)選)**
先帝[^注釋1]創(chuàng)業(yè)[^注釋2]未半而中道[^注釋3]崩殂[^注釋4],今[^注釋5]天下三分[^注釋6],益州疲弊[^注釋7],此[^注釋8]誠(chéng)危急存亡之秋也。然[^注釋9]侍衛(wèi)之臣不懈于內(nèi),忠志之士忘身[^注釋10]于外者,蓋追先帝之殊遇[^注釋11],欲報(bào)之于陛下也。誠(chéng)[^注釋12]宜開張圣聽[^注釋13],以光[^注釋14]先帝遺德,恢弘[^注釋15]志士之氣,不宜妄自菲薄[^注釋16],引喻失義[^注釋17],以塞忠諫之路也[^注釋18]。
[^注釋1]: 先帝:指漢昭烈帝劉備。先,尊稱死去的人。
[^注釋2]: 創(chuàng):開創(chuàng),創(chuàng)立;業(yè):統(tǒng)一天下的大業(yè)。
[^注釋3]: 中道:中途。
[^注釋4]: 崩殂(cú):死。崩,古時(shí)指皇帝死亡。殂,死亡。
[^注釋5]: 今:現(xiàn)在。
[^注釋6]: 三分:天下分為孫權(quán),曹操,劉備三大勢(shì)力。
[^注釋7]: 益州疲弊:弱,處境艱難;益州:漢代行政區(qū)域十三刺史部之一,包括今四川省和陜西省一帶,這里指蜀漢。疲弊(pí bì):人力缺乏,物力缺無(wú),民生凋敝。
[^注釋8]: 此:這;誠(chéng):的確,實(shí)在;之:的;秋:時(shí),時(shí)候,這里指關(guān)鍵時(shí)期,一般多指不好的。
[^注釋9]: 然:然而;侍:侍奉;衛(wèi):護(hù)衛(wèi);懈:松懈,懈怠;于:在;內(nèi):皇宮中。
[^注釋10]: 忘身:舍身忘死,奮不顧身。
[^注釋11]: 蓋:原來(lái);追:追念;殊遇:優(yōu)待,厚遇。
[^注釋12]: 誠(chéng):的確,確實(shí);宜:應(yīng)該。
[^注釋13]: 開張圣聽:擴(kuò)大圣明的聽聞,意思是要后主廣泛地聽取別人的意見;開張,擴(kuò)大。
[^注釋14]: 光:發(fā)揚(yáng)光大,用作動(dòng)詞;遺德:留下的美德。
[^注釋15]: 恢弘:發(fā)揚(yáng)擴(kuò)大,用作動(dòng)詞。恢,大。弘,大,寬,這里是動(dòng)詞,也做“恢宏”;氣:志氣。
[^注釋16]: 妄自菲?。哼^于看輕自己;妄:過分;菲?。盒】?,輕視。
[^注釋17]: 引喻失義:講話不恰當(dāng)。引喻:稱引、譬喻;喻:比如;義:適宜、恰當(dāng)。
[^注釋18]: 以:以致(與以傷先帝之明的以用法相同:以致);塞:阻塞;諫:勸諫。
其渲染效果如下:
4. 小結(jié)
- 尾注和腳注是用來(lái)對(duì)文字內(nèi)容做補(bǔ)充說(shuō)明的標(biāo)記格式;
- 尾注和腳注聲明的方式與超鏈接很像,但比超鏈接多了一個(gè)
^
符號(hào); - 尾注和腳注在 Markdown 的寫法一樣,區(qū)別在于不同其注釋描述的插入位置不同;
- 對(duì)于不分頁(yè)的文章,建議優(yōu)先采用尾注的形式,保證格式的統(tǒng)一。