feat(core): update type parameters listing format

Author: tgreyuk

packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts

@@ -102,7 +102,11 @@ export function declaration(
     if (this.helpers.useTableFormat('parameters')) {
       md.push(this.partials.typeParametersTable(model.typeParameters));
     } else {
-      md.push(this.partials.typeParametersList(model.typeParameters));
+      md.push(
+        this.partials.typeParametersList(model.typeParameters, {
+          headingLevel: options.headingLevel,
+        }),
+      );
     }
   }
 

packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberWithGroups.ts

@@ -40,7 +40,11 @@ export function memberWithGroups(
     if (this.helpers.useTableFormat('parameters')) {
       md.push(this.partials.typeParametersTable(model.typeParameters));
     } else {
-      md.push(this.partials.typeParametersList(model.typeParameters));
+      md.push(
+        this.partials.typeParametersList(model.typeParameters, {
+          headingLevel: options.headingLevel,
+        }),
+      );
     }
   }
 

packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts

@@ -76,7 +76,11 @@ export function signature(
     if (this.helpers.useTableFormat('parameters')) {
       md.push(this.partials.typeParametersTable(model.typeParameters));
     } else {
-      md.push(this.partials.typeParametersList(model.typeParameters));
+      md.push(
+        this.partials.typeParametersList(model.typeParameters, {
+          headingLevel: options.headingLevel,
+        }),
+      );
     }
   }
 

packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeParametersList.ts

@@ -1,31 +1,40 @@
-import { bold, italic } from '@plugin/libs/markdown/index.js';
+import { heading, italic } from '@plugin/libs/markdown/index.js';
 import { MarkdownThemeContext } from '@plugin/theme/index.js';
 import { TypeParameterReflection } from 'typedoc';
 
 export function typeParametersList(
   this: MarkdownThemeContext,
   model: TypeParameterReflection[],
+  options: { headingLevel: number },
 ): string {
   const rows: string[] = [];
   model?.forEach((typeParameter) => {
     const row: string[] = [];
 
-    const nameCol: string[] = [bold(typeParameter.name)];
+    row.push(heading(options.headingLevel + 1, typeParameter.name));
+
+    const nameCol: string[] = [];
 
     if (typeParameter.type) {
       nameCol.push(
-        `${italic('extends')} ${this.partials.someType(typeParameter.type)}`,
+        `${italic('extends')}: ${this.partials.someType(typeParameter.type)}`,
       );
     }
 
     if (typeParameter.default) {
-      nameCol.push(`= ${this.partials.someType(typeParameter.default)}`);
+      nameCol.push(
+        `${this.i18n.theme_default_type()} ${this.partials.someType(typeParameter.default)}`,
+      );
     }
 
-    row.push('• ' + nameCol.join(' '));
+    row.push(nameCol.join(''));
 
     if (typeParameter.comment) {
       row.push(this.partials.comment(typeParameter.comment));
+    } else {
+      if (nameCol.join('').length === 0) {
+        row.push('\\-');
+      }
     }
 
     rows.push(row.join('\n\n'));

packages/typedoc-plugin-markdown/src/theme/context/resources.ts

@@ -228,8 +228,10 @@ There is no association list partial for properties as these are handled as a st
       options: { kind?: ReflectionKind | undefined },
     ) =>
       partials.typeDeclarationTable.apply(context, [model, options]) as string,
-    typeParametersList: (model: TypeParameterReflection[]) =>
-      partials.typeParametersList.apply(context, [model]) as string,
+    typeParametersList: (
+      model: TypeParameterReflection[],
+      options: { headingLevel: number },
+    ) => partials.typeParametersList.apply(context, [model, options]) as string,
     typeParametersTable: (model: TypeParameterReflection[]) =>
       partials.typeParametersTable.apply(context, [model]) as string,
     breadcrumbs: () => partials.breadcrumbs.apply(context, []) as string,

packages/typedoc-plugin-markdown/test/fixtures/src/reflections/classes.ts

@@ -132,8 +132,8 @@ export class ClassWithConstructorOverloads {
 /**
  * Comments for ClassWithTypeParameters
  *
- * @param A Comments for param A
  * @param B Comments for param B
+ * @param C Comments for param C
  */
 export class ClassWithTypeParameters<A, B extends string, C = boolean> {}
 

packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.class.spec.ts.snap

@@ -1238,15 +1238,21 @@ Comments for ClassWithTypeParameters
 
 ## Type Parameters
 
-• **A**
+### A
 
-Comments for param A
+\\-
 
-• **B** *extends* \`string\`
+### B
+
+*extends*: \`string\`
 
 Comments for param B
 
-• **C** = \`boolean\`
+### C
+
+Default type \`boolean\`
+
+Comments for param C
 
 ## Constructors
 
@@ -1269,9 +1275,9 @@ Comments for ClassWithTypeParameters
 
 | Type Parameter | Default type | Description |
 | :------ | :------ | :------ |
-| \`A\` | - | Comments for param A |
+| \`A\` | - | - |
 | \`B\` *extends* \`string\` | - | Comments for param B |
-| \`C\` | \`boolean\` | - |
+| \`C\` | \`boolean\` | Comments for param C |
 
 ## Constructors
 

packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.function.spec.ts.snap

@@ -23,7 +23,9 @@ Comments for current function 1
 
 #### Type Parameters
 
-• **Value**
+##### Value
+
+\\-
 
 #### Parameters
 
@@ -47,7 +49,9 @@ Comments for iterable arg
 
 ### Type Parameters
 
-• **Value**
+#### Value
+
+\\-
 
 ### Parameters
 
@@ -154,7 +158,9 @@ Comments for function
 
 ### Type Parameters
 
-• **T**
+#### T
+
+\\-
 
 ### Parameters
 
@@ -1161,11 +1167,13 @@ Function with type parameters
 
 ## Type Parameters
 
-• **T**
+### T
 
 Comments for T
 
-• **Item** = \`string\` \\| \`boolean\`
+### Item
+
+Default type \`string\` \\| \`boolean\`
 
 ## Returns
 

packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.interface.spec.ts.snap

@@ -641,22 +641,22 @@ And some more comments
 
 ## Type Parameters
 
-• **A**
+### A
 
 This is a parameter.
 
-• **B**
+### B
 
 Comments for a parameter.
 This sentence is on a soft new line.
 
-• **C**
+### C
 
 This is a parameter.
 
  Documentation with a double line
 
-• **D**
+### D
 
 <p>These are comments with paras</p>
 <p>These are comments with paras</p>
@@ -842,7 +842,9 @@ Comments for InterfaceWithTypeParameters
 
 ## Type Parameters
 
-• **A**
+### A
+
+\\-
 
 ## Properties
 

packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.type-alias.spec.ts.snap

@@ -37,7 +37,9 @@ Comments for ConditionalType
 
 ## Type Parameters
 
-• **T**
+### T
+
+\\-
 
 ## Source
 
@@ -429,7 +431,9 @@ Comments for PartialMappedType
 
 ## Type Parameters
 
-• **T**
+### T
+
+\\-
 
 ## Source
 
@@ -523,7 +527,9 @@ Comments for ReadonlyMapedType
 
 ## Type Parameters
 
-• **T**
+### T
+
+\\-
 
 ## Source
 
@@ -623,9 +629,13 @@ Comments for TypeWithTypeParams
 
 ## Type Parameters
 
-• **T**
+### T
+
+\\-
+
+### R
 
-• **R**
+\\-
 
 ## Source