Markdown support for hover documentation

[fbricon]

Currently, hover returns documentation as text, meaning if the content is actual html, then the client doesn't render it in a user-friendly way. See a hover over the <packaging> element of a pom.xml:

We could probably transform the html doc into markdown, using the remark library, like in jdt.ls. That'd also add jsoup as a dependency of the project.

[fbricon]

For now, the main issue I have with this approach is, escaped xml is swallowed during the markdown conversion. e.g for https:/felixfbecker/PowerShellXSD/blob/master/Test.Types.ps1xml:

[angelozerr]

We could probably transform the html doc into markdown, using the remark library, like in jdt.ls. That'd also add jsoup as a dependency of the project.

Could we not create our own (very simply) markdown parser for that:

• we will avoid having 2 new dependencies which will grow up the size of xml language server JAR
• we will manage the markdown parser for our need like "For now, the main issue I have with this approach is, escaped xml is swallowed during the markdown conversion. "

[angelozerr]

Fred i'm sorry to insist but i think we could use our xmlscanner to parse documentation and generate markdown. I think its not an hard task. No?

[fbricon]

From a technical perspective, it would probably be better/more efficient to reuse the xmlscanner. But I'm not sure how much work it will be to rewrite a complete markdown converter, I'm not sure it'll be as easy as you think. But feel free to explore that option