A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.
697
stars
173
forks
source link
[typedoc-plugin-markdown@next] Bug (Lint MD011): Using indexed access types (may) trigger reversed link syntax rule. #484
Closed
sharky98 closed 9 months ago
Hello,
This is probably an edge case. I am using indexed access types to obtain the type of an array's element.
This look like this.
ArrayOfStuff
andStuff
have both their own page. As such, a link is made in the resulting markdown. It looks like this.However, this syntax triggers the markdownlint rule MD011 about reversed link syntax.
Suggestion
To avoid this, the square brackets coming from the source code could be escaped.
Note: The rule is not triggered when the square brackets are empty, but I see not adverse effect of escaping them also.