search

typedoc2md / typedoc-plugin-markdown

A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.
https://typedoc-plugin-markdown.org
MIT License
689 stars 172 forks source link

markdown generated using triple quote making it icompatible with current docusaurus system #578

Closed axel7083 closed 4 months ago

axel7083 commented 4 months ago

In our system we have a broken link detected by docusaurus when it is not a broken link after long investigation it comes from a bug in the docusaurus codebase.

See https://github.com/facebook/docusaurus/issues/9876 for full discussion and the following comment on explanation https://github.com/facebook/docusaurus/issues/9876#issuecomment-1959197272

slorber commented 4 months ago

Hey

I wouldn't say it is "improper Markdown", after all this form of Markdown inline code blocks with triple backticks cause issues in Docusaurus, but apparently it's perfectly fine for MDX:

```something```

[test](test.md)

However, if you can migrate this kind of code to simple backticks, that would solve the problem on the Docusaurus side:

```something```

[test](test.md)
axel7083 commented 4 months ago

@slorber sorry for the wrong terminology!

axel7083 commented 4 months ago

Closing, as after investigation, we were the one, using triple quotes in our code comments. Which where just copy past by the plugin here.