mistune 0.8.4

功能

• pure python。在Python2.7、Python3.5+和Pypy中测试。
• 非常快。它是所有pure python标记解析器中最快的。
• 更多功能。表格、脚注、自动链接、围栏代码等。

查看benchmark results。

安装

使用pip安装mistune:

$ pip install mistune

如果使用cython编译，则mistune可能更快：

$ pip install cython mistune

基本用法

呈现标记格式文本的简单api：

importmistunemistune.markdown('I am using **mistune markdown parser**')# output: <p>I am using <strong>mistune markdown parser</strong></p>

如果您关心性能，最好重新使用降价实例：

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

默认情况下，mistune已启用所有功能。您不必配置 什么都行。但是您可以选择更改解析器行为。

选项

下面是将影响渲染结果的所有选项的列表， 用mistune.Renderer：

renderer=mistune.Renderer(escape=True,hard_wrap=True)# use this renderer instancemarkdown=mistune.Markdown(renderer=renderer)markdown(text)

• escape：如果设置为false，则不会对所有原始html标记进行转义。
• 硬包装：如果设置为true，它将具有gfm换行功能。 所有新行将替换为<br>标记
• 使用xhtml：如果设置为true，则所有标记都将使用xhtml，例如：<hr />。
• parse_block_html：仅在块级html中分析文本。
• parse_inline_html：仅在内联级html中分析文本。

使用默认渲染器时，可以使用以下快捷方式之一：

mistune.markdown(text, escape=True, hard_wrap=True)

markdown = mistune.Markdown(escape=True, hard_wrap=True)
markdown(text)

渲染器

与Misaka/Sundown类似，您可以通过自定义渲染器影响渲染。 您所需要做的就是子类化一个渲染器类。

下面是代码突出显示的示例：

importmistunefrompygmentsimporthighlightfrompygments.lexersimportget_lexer_by_namefrompygments.formattersimporthtmlclassHighlightRenderer(mistune.Renderer):defblock_code(self,code,lang):ifnotlang:return'\n<pre><code>%s</code></pre>\n'% \
                mistune.escape(code)lexer=get_lexer_by_name(lang,stripall=True)formatter=html.HtmlFormatter()returnhighlight(code,lexer,formatter)renderer=HighlightRenderer()markdown=mistune.Markdown(renderer=renderer)print(markdown('```python\nassert 1 == 1\n```'))

在mistune-contrib中查找更多渲染器。

block_code(code, language=None)
block_quote(text)
block_html(html)
header(text, level, raw=None)
hrule()
list(body, ordered=True)
list_item(text)
paragraph(text)
table(header, body)
table_row(content)
table_cell(content, **flags)

autolink(link, is_email=False)
codespan(text)
double_emphasis(text)
emphasis(text)
image(src, title, alt_text)
linebreak()
newline()
link(link, title, content)
strikethrough(text)
text(text)
inline_html(text)

footnote_ref(key, index)
footnote_item(key, text)
footnotes(text)

雷克萨斯

有时您希望添加自己的规则来标记，例如github wiki 链接。使用渲染器无法实现此目标。你需要处理 对于雷克萨斯来说，这将是第一次有点困难。

我们将以github wiki链接为例：[[Page 2|Page 2]]。 它是内联语法，需要自定义的InlineGrammar和 InlineLexer：

importcopy,refrommistuneimportRenderer,InlineGrammar,InlineLexerclassWikiLinkRenderer(Renderer):defwiki_link(self,alt,link):return'<a href="%s">%s</a>'%(link,alt)classWikiLinkInlineLexer(InlineLexer):defenable_wiki_link(self):# add wiki_link rulesself.rules.wiki_link=re.compile(r'\[\['# [[r'([\s\S]+?\|[\s\S]+?)'# Page 2|Page 2r'\]\](?!\])'# ]])# Add wiki_link parser to default rules# you can insert it some place you like# but place matters, maybe 3 is not goodself.default_rules.insert(3,'wiki_link')defoutput_wiki_link(self,m):text=m.group(1)alt,link=text.split('|')# you can create an custom render# you can also return the html if you likereturnself.renderer.wiki_link(alt,link)

您应该将内联lexer传递给Markdown解析器：

renderer=WikiLinkRenderer()inline=WikiLinkInlineLexer(renderer)# enable the featureinline.enable_wiki_link()markdown=Markdown(renderer,inline=inline)markdown('[[Link Text|Wiki Link]]')

与块级lexer相同。需要一段时间才能理解 整个机制。但你不会玩太多的把戏。

贡献和扩展

mistune本身不接受任何扩展。永远都是简单的 文件脚本。

如果要添加功能，可以转到mistune-contrib。

这里有一些扩展已经在mistune-contrib：

• math/mathjax特性
• 突出显示代码呈现器
• 目录功能表
• 多标记元数据分析器

从contrib存储库中获得灵感。