search

Doraku / DefaultDocumentation

Create a simple markdown documentation from the Visual Studio xml one.
MIT No Attribution
157 stars 26 forks source link

Missing escape characters #117

Open HuiyunPeng opened 2 years ago

HuiyunPeng commented 2 years ago

I was trying to load the generated markdown files into a website built with Docusaurus and got some compile errors like this: SyntaxError: C:\docs\defaultdocs\myFile.md: Expected corresponding JSX closing tag for <TimeSpan>...

The markdown code that caused this issue is ## myClassName(Nullable<TimeSpan>) Constructor.

My guess is that <and >should be escaped so the compiler won't think it's JSX.

Doraku commented 2 years ago

Erf even on Github I can see that it causes problem anyway as they are not rendered, I'll definitely have to to that.