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
697 stars 173 forks source link

[next] Some types are not getting output #470

Closed ziad-saab closed 10 months ago

ziad-saab commented 11 months ago

You can see an example of types not being output here:

https://docs.metamask.io/zs/keyring-doc/snaps/reference/keyring-api/Type%20Aliases/type-alias.Keyring/

The output looks like this:

image
tgreyuk commented 10 months ago

Fix versions

typedoc-plugin-markdown@4.0.0-next.21 docusaurus-plugin-typedoc@1.0.0-next.16

Changes

The full docs for the type is now correctly exposed under the 'Type declaration' heading (as per html theme)

Screenshot 2023-09-25 at 22 57 35

You will notice that type inside the declaration is collapsed to the word 'object'. This is because the expanded object is very large, but it can be expanded by the option expandObjects:true which will produce output as follows:

Screenshot 2023-09-25 at 23 03 59