TypeStrong / typedoc

Documentation generator for TypeScript projects.
https://typedoc.org
Apache License 2.0
7.7k stars 697 forks source link

Make object documentation less verbose #2756

Open norswap opened 2 hours ago

norswap commented 2 hours ago

Search Terms

variable, object, properties, expanded

Problem

I have an exported variable that is a deeply nested const object.

Using "expandObjects": true, I get a very pleasant code representation of my object in the docs.

However, every property gets listed in a way that is very noisy (every property gets its own title and section, as well as every sub-property, etc etc).

Example: https://happychain.pages.dev/react/api/variables/chains#type-declaration

Suggested Solution

An option that lets us choose between

Gerrit0 commented 2 hours ago

TypeDoc does not have an expandObjects option. This feature request needs to be made to whatever theme you are using, not here