Using Markdown to Generate HTML for Your Plugin's Description

IntelliJ plugin description stored in plugin.xml file uses HTML which is eventually displayed
by the Swing browser. Swing limitations make it difficult to accurately predict the rendering of
the final result. Markdown Navigator can be used to help with both generating the HTML from
Markdown and also to give a fair rendering representation.

Defining a scope that includes the plugin markdown description will allow you to control the
rendering profile and export settings strictly for the description file without affecting other
markdown documents in the project.

For example, if plugin description is stored in the assets/markdown/plugin-description.md file
then:

Create a scope that includes the parent directory or just the file:

Create a profile:

Since you will be using generated HTML you can enable all Markdown element extensions:

Un-check the Add page header option:

Now define the export options:

The file will be exported to the same directory with a .html extension.

Assign it to this scope:

Now you can edit the markdown plugin description and see the result in the preview. Saving the
file will automatically export the HTML.

Enabling preview for HTML documents will allow you to preview the raw HTML file:

Which will show the preview for the HTML:

All you need to do manually is to copy the HTML into the plugin.xml file.

The description for the installed plugin will look like:

Now you can edit the description in Markdown, see the preview and generate the HTML when done. The only
thing to remember is to copy the generated HTML to the plugin.xml.

The opinions expressed here are my own and are based on my experience, perceptions and interpretations. I do not care for political correctness or other means of steering debate away from topics that may be uncomfortable to some individuals or groups. I consider these to be social engineering efforts for someone else's benefit, not yours nor mine. As long as the discussion is civil and does not degrade into name calling or threats, it has a right to exist.

You are free to disagree with my opinions and if you find them in any way upsetting to your world view you are welcome to not read them.