Markdown你的文章和代码高亮

现在,如果你写文章不使用Markdown格式,那真的是out了。可见Markdown在当前写作领域发挥的重要作用,作为一种轻量级的标记语言,它的语法简单明了,为你省去排版烦恼。
以下将介绍我博客中的Markdown的使用历史,并高亮文章代码。

  • 阶段一

去年刚搭完博客的时候,我用了一个最傻瓜最粗暴的发式,现在想想也是醉了。方法如下:

先在你熟悉的Markdown编辑器写下你的文章,使用Html导出功能下载到本地,将Html文件的源码复制到Django后台,保存即可。

这种方法不需要用到任何的Markdown模块,虽然方法土了点,但是完全省去了程序渲染的步骤,高效至极。

关于此阶段的代码高亮,我使用的是hightlight.js这个插件,它可自动识别所须高亮的代码语言,能够对<pre><code></code></pre>添加样式,只需加上以下代码即可工作:

<link href="http://cdn.bootcss.com/highlight.js/8.0/styles/monokai_sublime.min.css" rel="stylesheet">  
<script src="http://cdn.bootcss.com/highlight.js/8.0/highlight.min.js"></script>
<script >hljs.initHighlightingOnLoad();</script>  
  • 阶段二

在使用阶段一的方法一段时间后,觉得很是麻烦,便使用Python的Markdown模块。安装方法如下:

sudo pip install markdown
#或
sudo pip install markdown

markdown与markdown2功能类似,使用上稍有不同,我均是将它们自定义了一个模板过滤器,下面仅仅是介绍了markdown2在Django中的使用。

  1. 在你的应用目录下新建一个名为templatetags的文件夹,并在其之下新建两个Python文件:__init__.py(使templatetags成为一个包),和blog_tags.py。编辑blog_tags.py文件:
import markdown2

from django import template
from django.template.defaultfilters import stringfilter
from django.utils.encoding import force_text
from django.utils.safestring import mark_safe

register = template.Library()

@register.filter(is_safe=True)
@stringfilter
def custom_markdown(value):
   return mark_safe(markdown2.markdown(force_text(value),
          extras=["fenced-code-blocks", "cuddled-lists", "metadata", "tables", "spoiler"]))

2.在模板文件中:

{{article.content | custom_markdown}}

3.前往https://github.com/richleland/pygments-css获取你喜欢的样式添加至模板文件。不要忘记在头部引入{% load blog_tags %}

  • 阶段三

后来无意中又在网上有发现了一个号称是Python中最快的markdown解析模块---mistune

sudo pip install mistune

放上官网上的一个简单例子:

import mistune

markdown = mistune.Markdown()
markdown('I am using **mistune markdown parser**')

blog_tags.py添加代码:

from django import template
import mistune
from pygments import highlight
from pygments.lexers import get_lexer_by_name
from pygments.formatters import HtmlFormatter

register = template.Library()

def block_code(text, lang, inlinestyles=False, linenos=False):
    if not lang:
        text = text.strip()
        return u'<pre><code>%s</code></pre>\n' % mistune.escape(text)

    try:
        lexer = get_lexer_by_name(lang, stripall=True)
        formatter = HtmlFormatter(
            noclasses=inlinestyles, linenos=linenos
        )
        code = highlight(text, lexer, formatter)
        if linenos:
            return '<div class="highlight">%s</div>\n' % code
        return code
    except:
        return '<pre class="%s"><code>%s</code></pre>\n' % (
            lang, mistune.escape(text)
        )


class HighlightMixin(object):
    def block_code(self, text, lang):
        # renderer has an options
        inlinestyles = self.options.get('inlinestyles')
        linenos = self.options.get('linenos')
        return block_code(text, lang, inlinestyles, linenos)


class TocRenderer(HighlightMixin, mistune.Renderer):
    pass

@register.filter
def markdown_detail(value):
    renderer = TocRenderer(linenos=True, inlinestyles=False)
    mdp = mistune.Markdown(escape=True, renderer=renderer)
    return mdp(value)

并在模板中使用之。

  • 测试

那么,至于以上介绍的三款markdown解析工具的解析速度到底怎么样呢?我写了测试如下:

import markdown, markdown2, mistune, time


def timeit(func):
    def wrapper(value):
        start = time.clock()
        func(value)
        end = time.clock()
        print ("%s used:%f" % (func.__name__, end-start))
    return wrapper


@timeit
def markdown_test(value):
    for i in xrange(0, 10000):
        res = markdown.markdown(value)


@timeit
def markdown2_test(value):
    for i in xrange(0, 10000):
        res = markdown2.markdown(value)


@timeit
def mistune_test(value):
    for i in xrange(0, 10000):
        res = mistune.markdown(value)

if __name__ == '__main__':
    text = '''
        >Hello world
        '''
    markdown_test(text)
    markdown2_test(text)
    mistune_test(text)

经过多次测试,结果基本相同:

测试结果

markdown2的作者说自己的模块解析速度比markdown要快,也确实如此。不过最令我惊讶的当属mistune,比markdown几乎快了10倍,果断使用之...

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,362评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,330评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,247评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,560评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,580评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,569评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,929评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,587评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,840评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,596评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,678评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,366评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,945评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,929评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,165评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,271评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,403评论 2 342

推荐阅读更多精彩内容