Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

View and navigate the entire type hierarchy #182

Closed
mattflix opened this issue Jan 26, 2016 · 7 comments
Closed

View and navigate the entire type hierarchy #182

mattflix opened this issue Jan 26, 2016 · 7 comments

Comments

@mattflix
Copy link

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.

@ThaNarie
Copy link

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

@mattflix
Copy link
Author

mattflix commented Feb 6, 2016

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?

@mattflix
Copy link
Author

mattflix commented Mar 3, 2016

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).

@balupton
Copy link

Why was this closed?

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Nov 29, 2020

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.

@Gerrit0 Gerrit0 reopened this Nov 29, 2020
@slalum
Copy link

slalum commented Jul 8, 2021

@mattflix Were you able to achieve this? I would like to have the same behavior.

@StoneCypher
Copy link
Contributor

also interested, discussing on discord

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

No branches or pull requests

6 participants