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
725 stars 177 forks source link

Overloaded class properties should be printed as separate items. #718

Open Huxpro opened 5 days ago

Huxpro commented 5 days ago

What package is the bug related to?

typedoc-plugin-markdown

Describe the issue

Source code:

export interface Foo { 
  getJSModule<Module = unknown>(name: string): Module;
  getJSModule(name: "GlobalEventEmitter"): GlobalEventEmitter;
}

Actual behaviors:

image

Expected behaviors:

Overloaded class properties should be printed as separate items.

TypeDoc configuration

Originally I thought this is a TypeDoc issue: https://github.com/TypeStrong/typedoc/issues/2767

But it seems like it's largely defined by the markdownTheme here.

A default configuration should be able to reproduce this issue.

Expected behavior

Overloaded class properties should be printed as separate items like TypeDoc html theme: https://github.com/TypeStrong/typedoc/issues/2767