Django搭建個人博客：渲染Markdown文章目錄

對會讀書的人來說，讀一本書要做的第一件事，就是仔細閱讀這本書的目錄。閱讀目錄可以對整體內容有所瞭解，並清楚地知道感興趣的部分在哪裏，提高閱讀質量。

博文也是同樣的，好的目錄對博主和讀者都很有幫助。更進一步的是，還可以在目錄中設置錨點，點擊標題就立即前往該處，非常的方便。

文中的目錄

之前我們已經爲博文支持了Markdown語法，現在繼續增強其功能。

有折騰代碼高亮的痛苦經歷之後，設置Markdown的目錄擴展就顯得特別輕鬆了。

修改文章詳情視圖：

article/views.py

...

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

僅僅是將將markdown.extensions.TOC擴展添加了進去。

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

代碼增加這一行就足夠了。爲了方便測試，往之前的文章中添加幾個一級標題、二級標題等。

還記得Markdown語法如何寫標題嗎？一級標題：# title1，二級標題：## title2

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

點擊標題，頁面就立即前往相應的標題處（即“錨點”的概念）。

任意位置的目錄

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

也簡單，這次需要修改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對象
    context = { 'article': article, 'toc': md.toc }

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

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

注意markdown.markdown()和markdown.Markdown()的區別

更詳細的解釋見：官方文檔

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

templates/article/detail.html

...

<div class="container">
    <div class="row">
        <!-- 將原有內容嵌套進新的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>

...

• 重新佈局，將原有內容裝進col-9的容器中，將右側col-3的空間留給目錄
• toc需要|safe標籤才能正確渲染

重新打開頁面：

總結

完成了文章的目錄功能，至此文章詳情頁面也比較完善了。

• 有疑問請在杜賽的個人網站留言，我會盡快回復。
• 或Email私信我：[email protected]
• 項目完整代碼：Django_blog_tutorial

轉載請註明出處。