django-mdpages 0.2

快速启动

假设您想创建一个about页面，其中包含 文件位于/pages/content/about.md。

1. 将“mdpages”添加到已安装的应用程序设置中，如下所示：

INSTALLED_APPS=[...'mdpages',]

1. 设置将包含标记的目录的位置 使用mdpages\u content目录设置中的文件：

MDPAGES_CONTENT_DIR='{}/pages/content/'.format(BASE_DIR)

1. 添加将包含标记生成内容的模板， 您将有两个可用变量：body和toc（对于 目录），例如创建模板 /templates/mdpages/page.html包含如下内容：

{%extends"base.html"%}{%blocktitle%}{{title}}{%endblock%}{%blockdescription%}{{description}}{%endblock%}{%blockcontent%}<divclass="container">{{toc|safe}}<hr>{{body|safe}}</div>{%endblock%}

并将模板路径添加到settingsmdpages\u template\u name：

MDPAGES_TEMPLATE_NAME='mdpages/page.html'

1. 使用指定 标记文件名md_file和模板名：

frommdpages.viewsimportMdPageViewclassAboutView(MdPageView):md_file='language-learning.md'# any kind of extra content used in your templateextra_context={'title':'About page','description':'This is the about page of the site.'}

1. 在url.py中使用它：：

from.viewsimportAboutViewurlpatterns=[path('about',AboutView.as_view()),]

参考

• 标记库https://python-markdown.github.io/reference/