When using the packages entry point strategy in typedoc and with the outputFileStrategy option set to modules it appears that the plugin is writing the module.index.md file for each package in the root output directory instead of in each package's subdirectory.
In the example repo below (taken from the typedoc documentation), run npm run docs. The packages "bar" and "baz" should generate their own module.index.md file in their respective directories, but it appears they are each generating their file in the parent folder (root output directory), overwriting the previous one if it exists. After the generation is complete, the module.index.md file will contain the content of whichever package was parsed last.
Expected Result:
docs/@typedoc/bar/module.index.md - generated doc for /packages/bar/index.ts
docs/@typedoc/baz/module.index.md - generated doc for /packages/baz/index.ts
docs/@typedoc/module.index.md - no file should exist
Actual Result:
docs/@typedoc/bar/module.index.md - does not exist
docs/@typedoc/baz/module.index.md - does not exist
docs/@typedoc/module.index.md – exists and will be the content of the last package parsed (packages/baz/index.ts).
When using the
packages
entry point strategy in typedoc and with theoutputFileStrategy
option set tomodules
it appears that the plugin is writing themodule.index.md
file for each package in the root output directory instead of in each package's subdirectory.In the example repo below (taken from the typedoc documentation), run
npm run docs
. The packages "bar" and "baz" should generate their ownmodule.index.md
file in their respective directories, but it appears they are each generating their file in the parent folder (root output directory), overwriting the previous one if it exists. After the generation is complete, themodule.index.md
file will contain the content of whichever package was parsed last.Expected Result:
docs/@typedoc/bar/module.index.md
- generated doc for /packages/bar/index.tsdocs/@typedoc/baz/module.index.md
- generated doc for /packages/baz/index.tsdocs/@typedoc/module.index.md
- no file should existActual Result:
docs/@typedoc/bar/module.index.md
- does not existdocs/@typedoc/baz/module.index.md
- does not existdocs/@typedoc/module.index.md
– exists and will be the content of the last package parsed (packages/baz/index.ts
).https://github.com/adambergman/typedoc-plugin-markdown-packages-module-index