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

Group by file #404

Closed christopher-buss closed 1 year ago

christopher-buss commented 1 year ago

Currently I have a class A that has three utility functions U1, U2, and U3. These are located in a file A.ts, and then re-exported in a file index.ts - which is the root of the project.

The format of the A.ts file is as follows:

// some types here

export function U1 {}
export function U2 {}
export function U3 {}

export class A {}

The three utility functions are only related to A, but currently I can either seem to get them to appear in their own md file seperately, or to include everything in a huge monolithic modules file. The only other solution I have found is to declare each file individually in the typedoc entryPoints, but this has its own complications. Is there any way I could achieve what I am looking for?

tgreyuk commented 1 year ago

Could you not declare export A.ts as an entrypoint? There have been some improvements made to file output in "next" version https://github.com/tgreyuk/typedoc-plugin-markdown/blob/next/packages/typedoc-plugin-markdown/docs/file-output-options.md

tgreyuk commented 1 year ago

I am actually going to close this. Typedoc works off things exported from modules (not files).