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

Unclear "Type declaration" section, option to hide it #345

Closed iliubinskii closed 1 year ago

iliubinskii commented 2 years ago

Thx again for the plugin.

I see unclear "Type declaration" section inside markdown documentation: image that contains this:

(trueWeight?, falseWeight?): boolean

This code duplicates what is seen above:

Readonly boolean: (trueWeight?: number, falseWeight?: number) => boolean

while losing parameter types.

I am not sure why it is needed.

If there reasons for it, is it possible at least to add an option to hide "Type declaration" section?

tgreyuk commented 2 years ago

It follows the pattern of default theme as a heading for anonymous types, but agree its not really needed. Would need to retain the correct heading hierarchy if removed - will look at it.

tgreyuk commented 1 year ago

Next version has a slightly different layout so this will no longer be relevant. For this reason closing this with no action.

aosnow commented 9 months ago

May I ask when this issue can be resolved!