I am streaming text within a JComponent. This text is formatted as Markdown. What is the suggested way to render it as such, instead of as plain text?

This looks great, thanks! I’ll follow-up in there if I have more questions :slight_smile:

import com.intellij.markdown.utils.MarkdownToHtmlConverter; CommonMarkFlavourDescriptor flavourDescriptor = new CommonMarkFlavourDescriptor(); String html = new MarkdownToHtmlConverter(flavourDescriptor).convertMarkdownToHtml(markdownString, null); It needs a complete document. I am still looking …

@vasiliy MarkdownToHtmlConverter is internal. @insyncwithfoo 's suggestion is better. DocMarkdownToHtmlConverter.convert(project, someMarkdownString) That said you may choose whatever lib can convert markdown, we are using the commonmark library to convert it to HTML. And one can customize it as …

Haven’t gotten to implementing this yet, but I have a follow-up question: How do I setup the markdown so that files can be clicked to open them as an Editor tab in the IDE?

How do I setup the markdown so that files can be clicked […] As in, links to files? If so, you can use a custom URI (say, yourplugin:///file.identifier/something#something) for the target, then extend com.intellij.platform.backend.documentation.linkHandler to handle such links however you want.

Suggested way to render Markdown

IntelliJ Platform

insyncwithfoo (InSync) March 21, 2025, 12:37am 2

Does this post help?

Topic		Replies	Views
Markdown presentation as stylized text in plugins IntelliJ Platform	2	292	March 19, 2025
MarkdownJCEFHtmlPanel removed in IJ 2026.2 IntelliJ Platform	2	84	July 11, 2026
Markdown plugin HTML preview doesn't include custom flavors provided via the "flavourProvider" IntelliJ Platform plugin-development	0	52	May 23, 2026
I'd like to have my plugin execute JavaScript code. What's the best way to do this? IntelliJ Platform	7	266	April 18, 2025
Is there a way to partial render of documentations in reader mode? IntelliJ Platform	1	119	August 13, 2025

Suggested way to render Markdown

Related topics