fix(core): expose group descriptions to module indexes

typedoc2md · Dec 25, 2024 · 87d044e · 87d044e
1 parent e798507
commit 87d044e
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 0 deletions.
diff --git a/.changeset/swift-seahorses-warn.md b/.changeset/swift-seahorses-warn.md
@@ -0,0 +1,5 @@
+---
+'typedoc-plugin-markdown': patch
+---
+
+- Expose group descriptions to module indexes.
diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.reflectionIndex.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.reflectionIndex.ts
@@ -30,6 +30,11 @@ export function reflectionIndex(
     groups?.forEach((reflectionGroup) => {
       if (reflectionGroup.categories) {
         md.push(heading(options.headingLevel, reflectionGroup.title) + '\n');
+        if (reflectionGroup.description) {
+          md.push(
+            this.helpers.getCommentParts(reflectionGroup.description) + '\n',
+          );
+        }
         reflectionGroup.categories.forEach((categoryGroup) => {
           md.push(
             heading(options.headingLevel + 1, categoryGroup.title) + '\n',
@@ -43,6 +48,11 @@ export function reflectionIndex(
         });
       } else {
         md.push(heading(options.headingLevel, reflectionGroup.title) + '\n');
+        if (reflectionGroup.description) {
+          md.push(
+            this.helpers.getCommentParts(reflectionGroup.description) + '\n',
+          );
+        }
         md.push(this.helpers.getGroupIndex(reflectionGroup) + '\n');
       }
     });

diff --git a/packages/typedoc-plugin-markdown/test/fixtures/src/groups/has-custom-groups.ts b/packages/typedoc-plugin-markdown/test/fixtures/src/groups/has-custom-groups.ts
@@ -1,6 +1,10 @@
 /**
  * A module that contains custom groupings
  *
+ * @groupDescription CustomGroupA
+ *
+ * Group description for CustomGroupA
+ *
  * @module
  */
 

diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/groups.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/groups.spec.ts.snap
@@ -1035,6 +1035,8 @@ A module that contains custom groupings
 
 ### CustomGroupA
 
+Group description for CustomGroupA
+
 | Variable | Description |
 | :------ | :------ |
 | [variabelA](variables/variabelA.md) | - |