Doraku / DefaultDocumentation

Create a simple markdown documentation from the Visual Studio xml one.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Missing escape characters

HuiyunPeng opened this issue · comments

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.

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