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

Duplicating content #385

Closed benmccann closed 1 year ago

benmccann commented 1 year ago

To reproduce (requires pnpm to be installed):

git clone git@github.com:JonasKruckenberg/imagetools.git
cd imagetools
pnpm install
pnpm doc

See that docs/README.md now contains imagetools / [Modules](modules.md) multiple times. Each time you run it, it will be added an additional time

tgreyuk commented 1 year ago

Its because the readme file is inside the output directory. It is basically creating a copy of it each time and adding the header. Really the README should be located outside of the generated docs folder.

tgreyuk commented 1 year ago

Closing this as no fix. But this issue won't actually happen in the next version (typedoc-plugin-markdown@next).

benmccann commented 1 year ago

thanks!