Add a outputFileStrategy for categories

[fb55]

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]

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

[Sytten]

@tgreyuk I would also be interested in that

[Sytten]

I will try to implement it, you can see the current doc we have here https://developer.caido.io/reference/sdks/backend/, it is a bit of a mess with all categories in one file.

[tgreyuk]

Thanks @Sytten .. I have actually looked at this and have almost arrived at a solution. I have also been looking at stripping back and refactoring the code as it is not very intuitive currently. But yes feel free to have a look.