Support `@groupDescription` tag for vitepress theme

[hntrl]

trafficstars

What package is the feature request related to?

typedoc-vitepress-theme

Background

Right now with the vitepress theme I can provide a @packageDocumentation or @module tag to add additional docs that's separate from the package README, and it will add it to the package index page.

If I wanted to add similar documentation for groups, I'd expect that I can use the @groupDescription tag to include it.

Instead what I have to do is hoist what would be that reference page out to a different file like this. If I could describe that in the group description and have that section be a backlink to the auto generated typedoc page, that would be ideal.

https://hntrl.github.io/eventkit/ https://github.com/hntrl/eventkit/

Proposed solution

When a groupDescription tag exists, it should render a page that can be accessed in a similar fashion to when you use packageDocumentation.

[tgreyuk]

Hi,

Thanks - this looks like a very similar request to an issue already raised with TypeDoc itself https://github.com/TypeStrong/typedoc/issues/2893.

Will monitor that issue and will attempt to align behaviour if there is a resolution.