Django渲染Markdown文章目錄的方法示例

更新時(shí)間：2019年01月02日 10:37:07 作者：杜賽

這篇文章主要介紹了Django渲染Markdown文章目錄的方法示例，小編覺得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧

對(duì)會(huì)讀書的人來說，讀一本書要做的第一件事，就是仔細(xì)閱讀這本書的目錄。閱讀目錄可以對(duì)整體內(nèi)容有所了解，并清楚地知道感興趣的部分在哪里，提高閱讀質(zhì)量。

博文也是同樣的，好的目錄對(duì)博主和讀者都很有幫助。更進(jìn)一步的是，還可以在目錄中設(shè)置錨點(diǎn)，點(diǎn)擊標(biāo)題就立即前往該處，非常的方便。

文中的目錄

之前我們已經(jīng)為博文支持了Markdown語法，現(xiàn)在繼續(xù)增強(qiáng)其功能。

有折騰代碼高亮的痛苦經(jīng)歷之后，設(shè)置Markdown的目錄擴(kuò)展就顯得特別輕松了。

修改文章詳情視圖：

article/views.py

...

# 文章詳情
def article_detail(request, id):
 ...
 article.body = markdown.markdown(article.body,
  extensions=[
  'markdown.extensions.extra',
  'markdown.extensions.codehilite',
   
  # 目錄擴(kuò)展
  'markdown.extensions.TOC',
  ]
 )
 ...

僅僅是將將markdown.extensions.TOC擴(kuò)展添加了進(jìn)去。

TOC: Table of Contents，即目錄的意思

代碼增加這一行就足夠了。為了方便測試，往之前的文章中添加幾個(gè)一級(jí)標(biāo)題、二級(jí)標(biāo)題等。

還記得Markdown語法如何寫標(biāo)題嗎？一級(jí)標(biāo)題：# title1，二級(jí)標(biāo)題：## title2

然后你可以在文中的任何地方插入[TOC]字符串，目錄就自動(dòng)生成好了：

點(diǎn)擊標(biāo)題，頁面就立即前往相應(yīng)的標(biāo)題處（即“錨點(diǎn)”的概念）。

任意位置的目錄

上面的方法只能將目錄插入到文章當(dāng)中。如果我想把目錄插入到頁面的任何一個(gè)位置呢？

也簡單，這次需要修改Markdown的渲染方法：

article/views.py

...

def article_detail(request, id):
 ...

 # 修改 Markdown 語法渲染
 md = markdown.Markdown(
  extensions=[
  'markdown.extensions.extra',
  'markdown.extensions.codehilite',
  'markdown.extensions.toc',
  ]
 )
 article.body = md.convert(article.body)

 # 新增了md.toc對(duì)象
 context = { 'article': article, 'toc': md.toc }

 return render(request, 'article/detail.html', context)

為了能將toc單獨(dú)提取出來，我們先將Markdown類賦值給一個(gè)臨時(shí)變量md，然后用convert()方法將正文渲染為html頁面。通過md.toc將目錄傳遞給模板。

注意markdown.markdown()和markdown.Markdown()的區(qū)別
更詳細(xì)的解釋見：官方文檔

為了將新的目錄渲染到頁面中，需要修改文章詳情模板：

templates/article/detail.html

...

<div class="container">
 <div class="row">
  <!-- 將原有內(nèi)容嵌套進(jìn)新的div中 -->
  <div class="col-9">
   <h1 class="mt-4 mb-4">{{ article.title }}</h1>
   <div class="alert alert-success">
    ...
   </div>
  </div>

  <!-- 新增的目錄 -->
  <div class="col-3 mt-4">
   <h4><strong>目錄</strong></h4>
   <hr>
   <div>
    {{ toc|safe }}
   </div>
  </div>
 </div>
</div>

...