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

Option to specify default non-categorized/grouped reflection name #2922

Open
sergeiivankov opened this issue Mar 28, 2025 · 0 comments
Open

Comments

@sergeiivankov
Copy link

Search Terms

none, default category, default group, top-level navigation

Problem

I try to make documentation navigation structure like next (with most common usage entities in top level navigation, without hidden its behind category/group dropdown element).

  • Entity1
  • Entity2
  • ...
  • Advanced category
    -- Advanced category Entity 1
    -- Advanced category Entity 2
    -- ...
  • Internal category
    -- Internal category Entity 1
    -- Internal category Entity 2
    -- ...

I found code

const none = reflection.find((x) => x.title.toLocaleLowerCase() === "none");
, so I named category for top level navigation entities None to get the behavior I want.

But in modules documentation page shows category name None, it's not very nice, I would like to be able to change this default name.

Image

I do this with categoriest, but I think this works similarly with groups too.

Suggested Solution

Add option for TypeDoc to change default name for non-collectibles reflections.

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

No branches or pull requests

1 participant