Organize by module/file with single index.ts entrypoint

[timakro]

So I'd like to organize items by the file they are defined in but my library uses a single index.ts with re-exports for the bundler. If I also use index.ts as the sole entrypoint for TypeDoc, then the structure router will group everything into one route as it sees index.ts as the sole module. (I am using typedoc-plugin-markdown and the same applies to their module router.) However if I pass source files as individual entry points to TypeDoc, the docs will include items that are only exported for internal use.

For now I am considering using @category annotations as a workaround with the category router. Another option would be to use individual entry points and annotate items that are exported for internal use with @internal. But I feel it is too easy to forget that annotation which will lead to internal types making it into the public docs.

Is there an intended way to achieve this? Maybe a good option would be to add a file router?

[Gerrit0]

TypeDoc's default theme really isn't intended to support multiple classes/functions/types/interfaces in a single output file, which is reflected by the router options available today. As typedoc-plugin-markdown does support this, I think for now I'd recommend making this a feature request there, it'd be nice if typedoc could do that, but that's not a super easy thing to do unfortunately.

You could in theory also write a plugin to re-arrange the module structure so that it mirrors file structures... that'd be kind of messy, but that combined with the structure router would probably be the easiest way to do this (that doesn't involve multiple entry points)