typedoc
typedoc copied to clipboard
TypeStrong
View and navigate the entire type hierarchy
This is a feature request for TypeDoc to provide (perhaps as a separate page in the generated docs) some way to view and navigate the complete type hierarchy in one place.
Currently, TypeDoc provides little views of the "local" hierarchy for each type, listing the immediately-derived types, but having some way to browse the entire hierarchy would be very helpful.
The feedback comes directly from my co-workers who, when when presented with TypeDoc for a project that I am working on, thought it was great, but immediately complained that it was difficult to learn about the type hierarchy.
If you're feeling lucky, you can always clone the default theme and make the desired changes yourself in a custom theme :) http://typedoc.io/guides/themes.html
Yes, but I find clear knowledge of the model objects used by the templates to be non-obvious (plus I'm not a handlebars expert).
Is the model documented somewhere?
Okay, it seems the internal model used by the handlebar templates bears some resemblance to the JSON output produced by the --json option, yes?
That's great, but it doesn't really address my initial complaint. I am still suggesting that TypeDoc generate documentation of the entire hierarchy somewhere in the output docs (perhaps the main page).
I was cleaning up issues which have had very little interest expressed in them + no activity in a couple years, I figured if anyone cared about them, they'd ask why they were closed or open a new issue.
In this case, I could see this still being useful for larger projects, if we only displayed the names/kind for each reflection + their children... I doubt I'll get to it anytime soon though, there are still 200 other issues, many with issues that are much more highly requested.
@mattflix Were you able to achieve this? I would like to have the same behavior.
