#2893·typedoc

Group summary pages?

Author: sporrittCreated Mar 12, 2025Updated Mar 16, 2025

Search Terms

group groupDescription category

Problem

I've recently started using @group and @category, which have helped me organise the docs a lot better. I arrange by group in the index so I get the collapsing menus and it's all good.

The main page lists out the contents of each group in order, and I was hoping for the ability to click on group names in the nav column and be taken to a summary page for that group, which would have the @groupDescription tag and then all of the group's members. Does this exist and I have just failed to find it? I see that the group description is being included in the json output.

Suggested Solution

An output config like includeGroupSummaryPages:boolean ?