Django 教程之添加markdown支持

布满荆棘的人生 2022-12-27 09:09 189阅读 0赞

为了让博客文章具有良好的排版，显示更加丰富的格式，我们使用 Markdown 语法来书写博文。Markdown 是一种 HTML 文本标记语言，只要遵循它约定的语法格式，Markdown 的解析工具就能够把 Markdown 文档转换为标准的 HTML 文档，从而使文章呈现更加丰富的格式，例如标题、列表、代码块等等 HTML 元素。由于 Markdown 语法简单直观，不用超过 5 分钟就可以轻松掌握常用的标记语法，因此大家青睐使用 Markdown 书写 HTML 文档。下面让我们的博客也支持使用 Markdown 写作

# 安装 Python Markdown #

pip install markdown

# 解析Markdown #

将 Markdown 格式的文本解析成 HTML 文本非常简单，只需调用这个库的 `markdown` 方法 ，这样我们再HTML中使用\{ \{ article\_post.body \}\}的时候就是markdown格式解析的HTML文本，一般我们使用safe标签，即\{ \{ article\_post.body|safe \}\}，这样可以避免Django出于安全将HTML代码转义。 在管道符号 | 后面加上 safe 过滤器后，渲染的值不再是 body 本身的值，而是由 safe 函数处理后返回的值

extensions是对 Markdown 语法的拓展

*  extra 本身包含很多基础拓展
 *  codehilite 是语法高亮拓展
 *  toc 则允许自动生成目录 ，美化锚点（忽略的标题的值，如中文）

class ArticleView(DetailView):
        model = Article
        template_name = 'article.html'
        context_object_name = 'article_post'
    
        def get_object(self, queryset=None):
            obj = super().get_object(queryset=None)
            # 文章可以使用markdown书写，带格式的文章，像csdn写markdown文章一样
            md = markdown.Markdown(extensions=[
                'markdown.extensions.extra',
                'markdown.extensions.codehilite',
                TocExtension(slugify=slugify),
            ])
            obj.body = md.convert(obj.body)
            # 匹配空目录，我没用，所以我再模板中使用了判断
            # m = re.search(r'<div class="toc">\s*<ul>(.*)</ul>\s*</div>', md.toc, re.S)
            # obj.toc = m.group(1) if m is not None else ''
            #{% if obj.toc %}
            # https://juejin.im/post/5d5ddec4f265da038f4812ed
            obj.toc = md.toc
            return obj