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
691 stars 171 forks source link

Breaks `typedoc-plugin-rename-defaults` (and possibly other ESM plugins) #530

Closed NanderTGA closed 6 months ago

NanderTGA commented 6 months ago

From typedoc-plugin-rename-defaults version 0.6.7, the API docs still get generated but don't get detected by Docusaurus (both on v2 and v3) until a rebuild is triggered. After some research on this issue (more information here), it seems that the plugin stopped working properly after they migrated to ESM. Reproduction

felipecrs commented 6 months ago

To provide a little more context, @Gerrit0 from TypeDoc suggests that typedoc-plugin-markdown may not be handling all promises correctly.

Personally I don't understand how that relates to CommonJS vs ESM, but any help in troubleshooting this issue would be welcome.

A blind idea I had was to migrate typedoc-plugin-markdown to ESM as well (which I suppose would happen someday anyway), hoping it may help with the issue.

Gerrit0 commented 6 months ago

Not the markdown plugin! The docusuaurus plugin.

tgreyuk commented 6 months ago

Thanks guys for all of the information. This should be fixed docusaurus-plugin-typedoc@0.22.0. As @Gerrit0 suggested ithe issue appears to be with the way the plugin was handling async stuff. Interestingly the TypeDoc async app methods were being processed correctly but not the dyamic imports of the esm plugins.