@

目录

• 小试牛刀
• 开始使用mistune
  • mistune简单使用
  • mistune高级用法(自定义mistune)
• mistune中插件
  • 插件使用方法(以 删除线(strikethrough) 为例)
  • 插件包名
  • 内置插件
    • 删除线(strikethrough)
    • 注脚(footnotes)
    • 表格(table)
    • 链接(url)
    • 任务列表
    • 描述列表
    • 缩写(abber)
• 解析器
  • 使用解析器
  • 可用的解析器功能列表
  • 自定义渲染器
• 创建插件
• 资源

小试牛刀

import mistune
from mistune.directives import DirectiveToc,DirectiveInclude
from mistune.plugins import plugin_footnotes,\
plugin_strikethrough,plugin_table,plugin_url,\
plugin_task_lists,plugin_def_list,plugin_abbr

renderer = mistune.HTMLRenderer()
markdown = mistune.create_markdown(renderer,escape=False,plugins=[DirectiveToc(),
                                               DirectiveInclude(),# toc支持
                                               plugin_footnotes, # 注脚
                                               plugin_strikethrough, # 删除线
                                               plugin_table, # 表格
                                               plugin_url, # 链接
                                               plugin_task_lists , # 任务列表
                                               plugin_def_list, # 自定义列表
                                               plugin_abbr, # 缩写
                                               ]
                            )
mdText = '''

@[toc]
# H1 title
~~here is the content~~
<https://typlog.com/>
https://typlog.com/
[链接](https://typlog.com/)

content in paragraph with footnote[^1] markup.

[^1]: footnote explain

## H2 title

- [x] item 1
- [ ] item 2

First term
: First definition
: Second definition

Second term
: Third definition

# H1 title

The HTML specification is maintained by the W3C.

*[HTML]: Hyper Text Markup Language
*[W3C]: World Wide Web Consortium

.. include:: study.md



'''

md_HTML = markdown(mdText)

with open("a.html","w+",encoding="utf-8") as f:
    f.write(md_HTML)

上述代码你跑成功了吗?是不是还有许多不解的地方?没关系下面有你想要的

开始使用mistune

mistune简单使用

import mistune

mistune.html(YOUR_MARKDOWN_TEXT)

mistune高级用法(自定义mistune)

import mistune

markdown = mistune.create_markdown()
markdown('YOUR_MARKDOWN_TEXT')

参数

参数	释义	默认值	备注
escape	HTML转义	TRUE	默认情况下将html文本转义,如:[1]
plugins	启用的插件功能	None	导入插件后添加到plugins中启用插件,他的传入值为列表,如:[2]
hard_wrap	将每一新行分成<br>	False	启用后md文件中的每一行都会解析成单独一行
renderer			默认选项有AST解析器mistune.AstRenderer()和HTML解析器mistune.HTMLRenderer() , 也可以自定义[3]

mistune中插件

插件使用方法(以 删除线(strikethrough) 为例)

mistune.html() 默认支持strikethrough. 创建自己的markdown实例:

markdown = mistune.create_markdown(plugins=['strikethrough'])

其他创建你自己的markdown实例的方法:

from mistune.plugins import plugin_strikethrough

renderer = mistune.HTMLRenderer()
markdown = mistune.Markdown(renderer, plugins=[plugin_strikethrough])

插件包名

内置插件

序号	插件目录	引用
1.	删除线(strikethrough)	from mistune.plugins import plugin_strikethrough
2	注脚(footnotes)	from mistune.plugins import plugin_footnotes
3	表格(table)	from mistune.plugins import plugin_table
4	链接(url)	from mistune.plugins import plugin_url
5	任务列表(task_lists)	from mistune.plugins import plugin_task_lists
6	描述列表(def_list)	from mistune.plugins import plugin_def_list
7	缩写(abbr)	from mistune.plugins import plugin_abbr

删除线(strikethrough)

语法:
~~here is the content~~
显示:
here is the content

注脚(footnotes)

语法: content in paragraph with footnote[^1] markup. [^1]: footnote explain
显示:

content in paragraph with footnote^[4] markup.

表格(table)

语法:
简易式表格 :
Simple formatted table:
First Header | Second Header
------------- | -------------
Content Cell | Content Cell
Content Cell | Content Cell
复杂的表格:
Complex formatted table:
| First Header | Second Header |
| ------------- | ------------- |
| Content Cell | Content Cell |
| Content Cell | Content Cell |
表格对齐
Align formatted table:
简易写法
Left Header | Center Header | Right Header
:----------- | :-------------: | ------------:
Conent Cell | Content Cell | Content Cell
复杂写法
| Left Header | Center Header | Right Header |
| :---------- | :-------------: | ------------: |
| Conent Cell | Content Cell | Content Cell |
显示:
First Header | Second Header
------------- | -------------
Content Cell | Content Cell
Content Cell | Content Cell

Left Header	Center Header	Right Header
Conent Cell	Content Cell	Content Cell

链接(url)

语法

允许使用默认的链接创建url
For instance, https://typlog.com/
显示:

For instance , https://typlog.com/

任务列表

语法
- [x] item 1
- [ ] item 2
显示:

• item 1
• item 2

描述列表

语法
First term
: First definition
: Second definition

Second term
: Third definition
显示:

First term

First definition

Second definition

Second term

Third definition

缩写(abber)

语法
The HTML specification is maintained by the W3C.
*[HTML]: Hyper Text Markup Language
*[W3C]: World Wide Web Consortium
显示:

The HTML specification is maintained by the W3C.

解析器

使用解析器

你可以使用自己的渲染器来自定义HTML的输出.创建一个mistune.HTMLRenderer的子类:

import mistune
from mistune import escape
class MyRenderer(mistune.HTMLRenderer):
    def codespan(self, text):
        if text.startswith('$') and text.endswith('$'):
            return '<span class="math">' + escape(text) + '</span>'
        return '<code>' + escape(text) + '</code>'

# 使用自定义解析器
markdown = mistune.create_markdown(renderer=MyRenderer())
print(markdown('hi `$a^2=4$`'))

可用的解析器功能列表

1.内联级 inline level

text(self, text)

link(self, link, text=None, title=None)

image(self, src, alt="", title=None)

emphasis(self, text)

strong(self, text)

codespan(self, text)

linebreak(self)

newline(self)

inline_html(self, html)

2.块级 block level

paragraph(self, text)

heading(self, text, level)

heading(self, text, level, tid) # when TOC directive is enabled

thematic_break(self)

block_text(self, text)

block_code(self, code, info=None)

block_quote(self, text)

block_html(self, html)

block_error(self, html)

list(self, text, ordered, level, start=None)

list_item(self, text, level)

3.由删除插件提供 provided by strikethrough plugin

strikethrough(self, text)

4.由表格插件提供 provide by table plugin

table(self, text)

table_head(self, text)

table_body(self, text)

table_row(self, text)

table_cell(self, text, align=None, is_head=False)

5.由注胶插件提供 provided by footnotes plugin

footnote_ref(self, key, index)

footnotes(self, text)

footnote_item(self, text, key, index)

6.确定最终呈现内容(定义输出) Finalize rendered content (define output)

finalize(self, data)

自定义渲染器

Midtune 支持开发者自定义渲染器功能,例如,创建一个代码高亮渲染器

import mistune
from pygments import highlight
from pygments.lexers import get_lexer_by_name
from pygments.formatters import html


class HighlightRenderer(mistune.HTMLRenderer):
    def block_code(self, code, lang=None):
        if lang:
            lexer = get_lexer_by_name(lang, stripall=True)
            formatter = html.HtmlFormatter()
            return highlight(code, lexer, formatter)
        return '<pre><code>' + mistune.escape(code) + '</code></pre>'

markdown = mistune.create_markdown(renderer=HighlightRenderer())

print(markdown('```python\nassert 1 == 1\n```'))

创建插件

Mistune有一些内置插件，您可以查看Mistune/plugins中的源代码，了解如何编写插件。让我们以GitHub Wiki链接为例：

一个mistune插件示例:

# 为Wiki链接定义正则表达式 define regex for Wiki links
import mistune
WIKI_PATTERN = (
    r'\[\['                   # [[
    r'([\s\S]+?\|[\s\S]+?)'   # Page 2|Page 2
    r'\]\](?!\])'             # ]]
)

# 定义如何解析匹配项 define how to parse matched item
def parse_wiki(inline, m, state):
    # ``inline`` is ``md.inline``, see below
    # "m"是匹配的正则表达式项 ``m`` is matched regex item
    text = m.group(1)
    title, link = text.split('|')
    return 'wiki', link, title

# 定义如何渲染HTML define how to render HTML
def render_html_wiki(link, title):
    return f'<a href="{link}">{title}</a>'

def plugin_wiki(md):
    # 这是一个内联语法，因此我们将wiki规则注册到md.inline中
    # this is an inline grammar, so we register wiki rule into md.inline
    # 语法: md.inline.register_rule(name, 正则表达式, 函数[解析匹配项])
    # 注意名字要一直匹配
    md.inline.register_rule('wiki', WIKI_PATTERN, parse_wiki)
    
    # 将wiki规则添加到活动规则中
    # add wiki rule into active rules
    md.inline.rules.append('wiki')

    # 添加HTML渲染器 add HTML renderer
    if md.renderer.NAME == 'html':
        md.renderer.register('wiki', render_html_wiki)

# 使用这个插件 use this plugin
markdown = mistune.create_markdown(plugins=[plugin_wiki])

资源

名称	链接
官方说明	https://mistune.readthedocs.io/en/v2.0.4/guide.html
mistune GitHub主页	https://github.com/lepture/mistune
mistune 作者写的其他插件	https://github.com/lepture/mistune-contrib

---

1. markdown('<div>hello</div>') 返回 '<div>hello</div>' ↩︎

2. markdown = mistune.create_markdown(plugins=['strikethrough']) # 启用删除线插件 ↩︎

3. renderer = mistune.HTMLRenderer() markdown = mistune.create_markdown(renderer) ↩︎

4. footnote explain ↩︎