Skip to content

Commit 032c742

Browse files
📚 DOCS: Add section about markdown renderer (#227)
Co-authored-by: Chris Sewell <[email protected]>
1 parent c9f6856 commit 032c742

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

docs/using.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -397,3 +397,29 @@ md = MarkdownIt("commonmark")
397397
md.add_render_rule("link_open", render_blank_link)
398398
print(md.render("[a]\n\n[a]: b"))
399399
```
400+
401+
### Markdown renderer
402+
403+
You can also render a token stream directly to markdown via the `MDRenderer` class from [`mdformat`](https://github.com/executablebooks/mdformat):
404+
405+
```{code-cell} python
406+
from markdown_it import MarkdownIt
407+
from mdformat.renderer import MDRenderer
408+
409+
md = MarkdownIt("commonmark")
410+
411+
source_markdown = """
412+
Here's some *text*
413+
414+
1. a list
415+
416+
> a *quote*"""
417+
418+
tokens = md.parse(source_markdown)
419+
420+
renderer = MDRenderer()
421+
options = {}
422+
env = {}
423+
424+
output_markdown = renderer.render(tokens, options, env)
425+
```

0 commit comments

Comments
 (0)