對會讀書的人來說，讀一本書要做的第一件事，就是仔細閱讀這本書的目錄。閱讀目錄可以對整體內容有所了解，并清楚地知道感興趣的部分在哪里，提高閱讀質量。
博文也是同樣的，好的目錄對博主和讀者都很有幫助。更進一步的是，還可以在目錄中設置錨點，點擊標題就立即前往該處，非常的方便。
文中的目錄
之前我們已經為博文支持了markdown語法，現在繼續增強其功能。
有折騰代碼高亮的痛苦經歷之后，設置markdown的目錄擴展就顯得特別輕松了。
修改文章詳情視圖：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
|
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的渲染方法：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
|
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()的區別更詳細的解釋見：官方文檔
為了將新的目錄渲染到頁面中，需要修改文章詳情模板：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
|
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標簽才能正確渲染
重新打開頁面：
總結
完成了文章的目錄功能，至此文章詳情頁面也比較完善了。
項目完整代碼：django_blog_tutorial
以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持服務器之家。
原文鏈接：https://segmentfault.com/a/1190000017578378
