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
714 stars 176 forks source link

Package not working with typedoc v0.24.0 because of `PageEvent` breaking change #405

Closed domingo2000 closed 1 year ago

domingo2000 commented 1 year ago

With the breaking changes of TypeDoc v0.24.0 the project is not longer working

Current Behaviour

Today I installed TypeDoc and typedoc-plugin-markdown, followed the instructions and throwed the following error.

TypeDoc exiting with unexpected error:
TypeError: page.template is not a function

I tracked the error through the files and realized that in Theme.ts the Theme.render() only takes the page, while in the last version of typedoc it takes (page, template) as specified in Changelog

"PageEvent no longer includes the template property. The Theme.render method is now expected to take the template to render the page with as its second argument."

I can submit a PR to fix it

domingo2000 commented 1 year ago

Now that I tried to make the fix, i saw that when forking the repository it installs TypeDoc 0.23, not 0.24, should i downgrade the TypeDoc in my project to make the markdown plugin works?, Or should we fix the breaking changes in the library?

Gilbert5210 commented 1 year ago

me too

Gilbert5210 commented 1 year ago

@tgreyuk can you help me???

Gilbert5210 commented 1 year ago

@domingo2000 what can you do to fix it

tgreyuk commented 1 year ago

Fix in typedoc-plugin-markdown@3.15.0

NSeydoux commented 1 year ago

Thanks, that fixed the issue for me.