feat: Added 'titleTemplate' option

typedoc2md · Jul 24, 2023 · d5af818 · d5af818
1 parent 5a85354
commit d5af818
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 12 deletions.
diff --git a/packages/typedoc-plugin-markdown/src/index.ts b/packages/typedoc-plugin-markdown/src/index.ts
@@ -81,18 +81,26 @@ export function load(app: Application) {
     defaultValue: false,
   });
 
-
   app.options.addDeclaration({
     help: '[Markdown Plugin] Specify the Type Declaration Render Style',
     name: 'objectLiteralTypeDeclarationStyle',
     type: ParameterType.String,
-    defaultValue: "table",
+    defaultValue: 'table',
     validate: (x) => {
-      const availableValues = ["table", "list"];
-      if (!availableValues.includes(x)){
-        throw new Error(`Wrong value for objectLiteralTypeDeclarationStyle, the expected value is one of ${availableValues}`)
+      const availableValues = ['table', 'list'];
+      if (!availableValues.includes(x)) {
+        throw new Error(
+          `Wrong value for objectLiteralTypeDeclarationStyle, the expected value is one of ${availableValues}`,
+        );
       }
-    }
+    },
+  });
+
+  app.options.addDeclaration({
+    help: '[Markdown Plugin] Specify a template for displaying page titles.',
+    name: 'titleTemplate',
+    type: ParameterType.String,
+    defaultValue: '{kind}: {title}',
   });
 }
 export { MarkdownTheme };
diff --git a/packages/typedoc-plugin-markdown/src/resources/helpers/reflection-title.ts b/packages/typedoc-plugin-markdown/src/resources/helpers/reflection-title.ts
@@ -7,13 +7,11 @@ export default function (theme: MarkdownTheme) {
   Handlebars.registerHelper(
     'reflectionTitle',
     function (this: PageEvent<any>, shouldEscape = true) {
-      const title: string[] = [''];
-      if (this.model?.kind && this.url !== this.project.url) {
-        title.push(`${ReflectionKind.singularString(this.model.kind)}: `);
-      }
+      const titleTemplate = theme.getOption('titleTemplate') as string;
       if (this.url === this.project.url) {
-        title.push(theme.indexTitle || getDisplayName(this.model));
+        return theme.indexTitle || getDisplayName(this.model);
       } else {
+        const title: string[] = [''];
         title.push(
           shouldEscape ? escapeChars(this.model.name) : this.model.name,
         );
@@ -23,8 +21,12 @@ export default function (theme: MarkdownTheme) {
             .join(', ');
           title.push(`<${typeParameters}${shouldEscape ? '\\>' : '>'}`);
         }
+        return this.model.kind
+          ? titleTemplate
+              .replace('{title}', title.join(''))
+              .replace('{kind}', ReflectionKind.singularString(this.model.kind))
+          : title.join('');
       }
-      return title.join('');
     },
   );
 }