typedoc-plugin-markdown icon indicating copy to clipboard operation
typedoc-plugin-markdown copied to clipboard

Published 20 hours ago • verified publisher icon typedoc2md

The readmeFile param monorepo config is not considered when the .md file is generated

Open maz-e opened this issue 2 years ago • 1 comments

As it says in https://typedoc.org/guides/monorepo/#typedoc-package-config, the README file set in the readmeFile config should be displayed on the index page of the package doc. Still, when the plugin generates the package/module .md file, only the classes, types or interfaces are displayed, and the README file is removed from the content.

maz-e avatar Jan 10 '23 15:01 maz-e

This had been fixed, but only in the next version. (typedoc-plugin-markdown@next).

tgreyuk avatar Jan 29 '23 23:01 tgreyuk

[email protected]

tgreyuk avatar May 03 '24 16:05 tgreyuk