typedoc-plugin-markdown
typedoc-plugin-markdown copied to clipboard
Make object documentation less verbose
What package is the feature request related to?
typedoc-plugin-markdown
Background
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
Proposed solution
An option that lets us choose between
- the current behaviour
- not rendering documentation (sections) for any property
- only rendering documentation (sections) for properties that have their own docstring