mistune-json 0.1.0

No project description provided

Mistune JSON

A JSON renderer for the Mistune Markdown parser.

Supported HTML elements

So far, the HTML elements supported by this renderer are limited to:

• Paragraph, <p>
• Image, <img>
• Ordered lists, <ol>
• Unordered lists, <ul>
• All heading elements, <h1> through <h6>
• Links, <a>
• Emphasis, <em>
• Strong, <strong>
• Blockquote, <blockquote>
• Line breake, <br>
• Thematic breake, <hr>
• Both inline and block code

How to use the JSON renderer

Installation

The package is not yet published in PyPI, but once it is, it will be installed with:

pip install mistune-json

Usage

import mistune
from mistune_json import JsonRenderer

# Create a renderer instance
renderer = JsonRenderer()

# Create a Markdown parser with the JSON renderer
markdown = mistune.create_markdown(renderer=renderer)

# Parse Markdown text
result = markdown("# Hello, world!")

print(result)
# {'content': [{'type': 'h', 'content': ['type': 'text', 'content': 'Hello, world!'], 'level': 1}]}

Improvements and bugs

Tables

There is currently no support for rendering tables (headers and rows). It might be added in the future, if there is enough need for it. You can rise an issue here and label it as enhancement.

Integration testing

Tests for a full Markdown document will be added to assure that the JSON render works as expected.

Bugs

If you find a problem with the JSON output structure, feel free to report a bug.