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

How can I put Functions on top of the order? #2109

Closed
inokawa opened this issue Nov 25, 2022 · 3 comments
Closed

How can I put Functions on top of the order? #2109

inokawa opened this issue Nov 25, 2022 · 3 comments
Labels
question Question about functionality

Comments

@inokawa
Copy link

inokawa commented Nov 25, 2022

Hi, at first, thank you for this nice project!

Search terms

kind sort order

Question

How can I put Functions on top of the order?

I'm trying to use typedoc in my own React library.
In recent typical React projects, Functions are commonly used than Classes.
So I want to display Functions before any other kinds.

I tried categoryOrder and sort option but had no luck.

@inokawa inokawa added the question Question about functionality label Nov 25, 2022
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Nov 25, 2022

Not possible today without a custom plugin - the kind sort order uses a predefined list https://github.com/TypeStrong/typedoc/blob/master/src/lib/utils/sort.ts

Adding an option to be able to define this list wouldn't be terrible...

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Dec 11, 2022

Site is still building, but this is now possible with kindSortOrder

TypeStrong/typedoc-site@e24b4cc

@inokawa
Copy link
Author

inokawa commented Dec 12, 2022

I tried it. Thank you so much!

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

No branches or pull requests

2 participants