Skip to main content

The fastest markdown parser in pure Python

Project description

The fastest markdown parser in pure Python, inspired by marked.

Wheel Status Latest Version Travis CI Status Coverage Status App Veyor CI Status

Features

  • Pure Python. Tested in Python 2.6+, Python 3.3+ and PyPy.

  • Very Fast. It is the fastest in all pure Python markdown parsers.

  • More Features. Table, footnotes, autolink, fenced code etc.

View the benchmark results.

Installation

Installing mistune with pip:

$ pip install mistune

If pip is not available, try easy_install:

$ easy_install mistune

Cython Feature

Mistune can be faster, if you compile with cython:

$ pip install cython mistune

Basic Usage

A simple API that render a markdown formatted text:

import mistune

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

Mistune has all features by default. You don’t have to configure anything.

Renderer

Like misaka/sundown, you can influence the rendering by custom renderers. All you need to do is subclassing a Renderer class.

Here is an example of code highlighting:

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

class MyRenderer(mistune.Renderer):
    def block_code(self, code, lang):
        if not lang:
            return '\n<pre><code>%s</code></pre>\n' % \
                mistune.escape(code)
        lexer = get_lexer_by_name(lang, stripall=True)
        formatter = HtmlFormatter()
        return highlight(code, lexer, formatter)

renderer = MyRenderer()
md = mistune.Markdown(renderer=renderer)
print(md.render('Some Markdown text.'))

Block Level

Here is a list of block level renderer API:

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)

The flags tells you whether it is header with flags['header']. And it also tells you the align with flags['align'].

Span Level

Here is a list of span level renderer API:

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

Options

Here is a list of all options that will affect the rendering results:

renderer = mistune.Renderer(escape=True)
md = mistune.Markdown(renderer=renderer)
md.render(text)
  • escape: if set to True, all raw html tags will be escaped.

  • hard_wrap: if set to True, it will has GFM line breaks feature.

  • use_xhtml: if set to True, all tags will be in xhtml, for example: <hr />.

  • parse_html: parse text in block level html.

When using the default renderer, you can use one of the following shorthands:

mistune.markdown(text, escape=True)

md = mistune.Markdown(escape=True)
md.render(text)

Lexers

Sometimes you want to add your own rules to Markdown, such as GitHub Wiki links. You can’t achieve this goal with renderers. You will need to deal with the lexers, it would be a little difficult for the first time.

We will take an example for GitHub Wiki links: [[Page 2|Page 2]]. It is an inline grammar, which requires custom InlineGrammar and InlineLexer:

import copy
from mistune import Renderer, InlineGrammar, InlineLexer

class MyRenderer(Renderer):
    def wiki_link(self, alt, link):
        return '<a href="%s">%s</a>' % (link, alt)


class MyInlineGrammar(InlineGrammar):
    # it would take a while for creating the right regex
    wiki_link = re.compile(
        r'\[\['                   # [[
        r'([\s\S]+?\|[\s\S]+?)'   # Page 2|Page 2
        r'\]\](?!\])'             # ]]
    )


class MyInlineLexer(InlineLexer):
    default_rules = copy.copy(InlineLexer.default_rules)

    # Add wiki_link parser to default rules
    # you can insert it any place you like
    default_rules.insert(3, 'wiki_link')

    def __init__(self, renderer, rules=None, **kwargs):
        if rules is None:
            # use the inline grammar
            rules = MyInlineGrammar()

        super(MyInlineLexer, self).__init__(renderer, rules, **kwargs)

    def output_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 like
        return self.renderer.wiki_link(alt, link)

You should pass the inline lexer to Markdown parser:

renderer = MyRenderer()
inline = MyInlineLexer(renderer)
markdown = Markdown(renderer, inline=inline)
markdown('[[Link Text|Wiki Link]]')

It is the same with block level lexer. It would take a while to understand the whole mechanism. But you won’t do the trick a lot.

Contribution

Mistune itself doesn’t accept any extension. It will always be a simple one file script.

If you want to add features, you can head over to mistune-contrib.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mistune-0.6.tar.gz (47.0 kB view details)

Uploaded Source

Built Distributions

mistune-0.6-py2.py3-none-any.whl (14.7 kB view details)

Uploaded Python 2Python 3

mistune-0.6-cp34-cp34m-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl (408.9 kB view details)

Uploaded CPython 3.4mmacOS 10.10+ Intel (x86-64, i386)macOS 10.10+ x86-64macOS 10.6+ Intel (x86-64, i386)macOS 10.9+ Intel (x86-64, i386)macOS 10.9+ x86-64

mistune-0.6-cp33-cp33m-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl (406.9 kB view details)

Uploaded CPython 3.3mmacOS 10.10+ Intel (x86-64, i386)macOS 10.10+ x86-64macOS 10.6+ Intel (x86-64, i386)macOS 10.9+ Intel (x86-64, i386)macOS 10.9+ x86-64

mistune-0.6-cp27-none-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl (398.2 kB view details)

Uploaded CPython 2.7macOS 10.10+ Intel (x86-64, i386)macOS 10.10+ x86-64macOS 10.6+ Intel (x86-64, i386)macOS 10.9+ Intel (x86-64, i386)macOS 10.9+ x86-64

File details

Details for the file mistune-0.6.tar.gz.

File metadata

  • Download URL: mistune-0.6.tar.gz
  • Upload date:
  • Size: 47.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for mistune-0.6.tar.gz
Algorithm Hash digest
SHA256 d54a69365d01bc97412a39c11674a8aae3f333586e91f38895cc1ad818e13dc5
MD5 9df3a09eeb3440f9fd50b08133fdbf9c
BLAKE2b-256 c75267cc5e5657e8e7eaf54a583d9c47f078517d702d3bbe3d6f3a04cace8dfb

See more details on using hashes here.

File details

Details for the file mistune-0.6-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for mistune-0.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 7550d44ab5fdc00d11007376048edd3d4760ba3202b8b4149bdc4e8147c6cc0e
MD5 7dd4dd34d590d78916c02b78f180d0a4
BLAKE2b-256 64be5cdf33c9a185b97c93617c8d5c158bd75afa6b9ecc66e0a534d4d346ebff

See more details on using hashes here.

File details

Details for the file mistune-0.6-cp34-cp34m-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl.

File metadata

File hashes

Hashes for mistune-0.6-cp34-cp34m-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl
Algorithm Hash digest
SHA256 d2bce140a1105d29b0a8a09a0023ad85d87a0f3cf29d08e2d848e3912cf3dcd8
MD5 29c79e3a7a8a0442c34e00dc104a50a4
BLAKE2b-256 89f4ce515c5b311a06550231fa5cf2a9286918925c84f4a380b5ffc7e0216b8a

See more details on using hashes here.

File details

Details for the file mistune-0.6-cp33-cp33m-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl.

File metadata

File hashes

Hashes for mistune-0.6-cp33-cp33m-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl
Algorithm Hash digest
SHA256 493f8a34e885f9bd936d6037fe1efbef2ec549841a12ae43d9d3baee2f89b0c2
MD5 0433fdfe7ba9f7311b47fe24b20aba9b
BLAKE2b-256 56987f7b3fc8ab09302c4b58173eaae56646e75ac742d81dbda65852d048f71a

See more details on using hashes here.

File details

Details for the file mistune-0.6-cp27-none-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl.

File metadata

File hashes

Hashes for mistune-0.6-cp27-none-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl
Algorithm Hash digest
SHA256 74193096cbe4b3bee9b0d28cdd76b84f23be5d3621bac8dd8d4b328baf46ab31
MD5 97864a6b840e669ad4116715c8f4e6b9
BLAKE2b-256 fa665019c5767452eed6b11af82897c97a147cb8e65c8d6d4ab8d98c4c174597

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page