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

Add a outputFileStrategy for categories #666

Open
fb55 opened this issue Aug 6, 2024 · 2 comments
Open

Add a outputFileStrategy for categories #666

fb55 opened this issue Aug 6, 2024 · 2 comments

Comments

@fb55
Copy link

fb55 commented Aug 6, 2024

What package is the feature request related to?

typedoc-plugin-markdown

Background

The Cheerio project has a core class with many, many methods. The methods are already grouped by category in the sidebar of the page, but it would be a big improvement if the page was split by category. Current issues include indexing issues from Algolia (the site search does not pick up the file as it is too large) and UX issues due to too much information being on the same page.

Proposed solution

Add a strategy to split classes by category. Alternatively, this might be another option similar to membersWithOwnFile (eg. categoriesWithOwnFile).

It might be nice to also switch between the strategies automatically, based on the number of entries on a particular page.

@tgreyuk
Copy link
Member

tgreyuk commented Aug 8, 2024

Thanks - this is an interesting idea. I'll try and find some time to do a bit of a spike on it.

@Sytten
Copy link

Sytten commented Oct 1, 2024

@tgreyuk I would also be interested in that

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

No branches or pull requests

3 participants