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

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

文中的目錄

之前我們已經(jīng)為博文支持了Markdown語(yǔ)法，現(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，即目錄的意思

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

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

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

image

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

任意位置的目錄

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

也簡(jiǎn)單，這次需要修改Markdown的渲染方法：

article/views.py

...

def article_detail(request, id):
    ...

    # 修改 Markdown 語(yǔ)法渲染
    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ú)提取出來(lái)，我們先將Markdown類(lèi)賦值給一個(gè)臨時(shí)變量md，然后用convert()方法將正文渲染為html頁(yè)面。通過(guò)md.toc將目錄傳遞給模板。

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

更詳細(xì)的解釋見(jiàn)：官方文檔

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

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>

...

• 重新布局，將原有內(nèi)容裝進(jìn)col-9的容器中，將右側(cè)col-3的空間留給目錄
• toc需要|safe標(biāo)簽才能正確渲染

重新打開(kāi)頁(yè)面：

image

總結(jié)

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

• 有疑問(wèn)請(qǐng)?jiān)?a target="_blank" rel="nofollow">杜賽的個(gè)人網(wǎng)站留言，我會(huì)盡快回復(fù)。
• 或Email私信我：dusaiphoto@foxmail.com
• 項(xiàng)目完整代碼：Django_blog_tutorial

轉(zhuǎn)載請(qǐng)注明出處。