typedoc2md / typedoc-plugin-markdown

A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.
https://typedoc-plugin-markdown.org
MIT License
725 stars 177 forks source link

Use {group} in textContentMappings #715

Open Huxpro opened 2 weeks ago

Huxpro commented 2 weeks ago

What package is the feature request related to?

typedoc-plugin-markdown

Background

@group is useful to simulate custom member types, e.g. @group Events, @group Components.

By allowing the use of {group}, it will be convenient to title file as Event: onClick or Component: Button() via textContentMappings.

Proposed solution

Support {group} in textContentMappings, or even a callback that does the string interpolation?

Maybe it's better to build a custom theme for this use case?