From ca5e1124561eb205cc4b9ff27d3d6d3669b90ac2 Mon Sep 17 00:00:00 2001 From: holamgadol Date: Fri, 25 Nov 2022 16:38:49 +0300 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9A=20DOCS:=20Add=20section=20about=20?= =?UTF-8?q?markdown=20renderer?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/using.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/docs/using.md b/docs/using.md index 83872037..0fa10d5d 100644 --- a/docs/using.md +++ b/docs/using.md @@ -397,3 +397,29 @@ md = MarkdownIt("commonmark") md.add_render_rule("link_open", render_blank_link) print(md.render("[a]\n\n[a]: b")) ``` + +### Markdown renderer + +You can also render a token stream directly to markdown via the `MDRenderer` class from [`mdformat`](https://github.com/executablebooks/mdformat): + +```{code-cell} python +from markdown_it import MarkdownIt +from mdformat.renderer import MDRenderer + +md = MarkdownIt("commonmark") + +source_markdown = """ +Here's some *text* + +1. a list + +> a *quote*""" + +tokens = md.parse(source_markdown) + +renderer = MDRenderer() +options = {} +env = {} + +output_markdown = renderer.render(tokens, options, env) +```