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
697 stars 173 forks source link

Docusaurus V3 Support #491

Closed strmer15 closed 9 months ago

strmer15 commented 9 months ago

Looks like Docusaurus V3 is now out - https://docusaurus.io/blog/releases/3.0

However, when I use this plugin, it's producing output that fails MDX compilation - for example, things like < and > now have to be strictly for JSX tags or escaped (https://docusaurus.io/docs/migration/v3#bad-usage-of--1). Can this plugin be updated to support Docusaurus v3?

Thanks for all your time and attention to maintaining this work!

xixixao commented 9 months ago

In case it's helpful to anyone, this is the commit in our private fork for supporting MDXv2:

https://github.com/get-convex/typedoc-plugin-markdown/commit/795e7a7b83b56cc3cbc659c0672a7d5d5aa62164

strmer15 commented 9 months ago

Thanks - that's very helpful!

My colleague noted that it looks like this is in the works, the 1.0.0-next.18 version says it has Docusaurus v3 support - https://github.com/tgreyuk/typedoc-plugin-markdown/blob/next/packages/docusaurus-plugin-typedoc/CHANGELOG.md

tgreyuk commented 9 months ago

@strmer15 thanks for raising this.

As you have just noted MDX2 support is already supported in next version, but if you are not ready to upgrade yet have also added support to main versions now:

strmer15 commented 9 months ago

Thanks @tgreyuk ! I updated to the latest and I've got it building again with Docusaurus v3 :tada: