fix: correctly render reference (#254)

packages/typedoc-plugin-markdown/src/render-utils.ts

@@ -7,6 +7,7 @@ import commentsHelper from './resources/helpers/comments';
 import declarationTitleHelper from './resources/helpers/declaration-title';
 import escapeHelper from './resources/helpers/escape';
 import hierarchyHelper from './resources/helpers/hierarchy';
+import ifIsReference from './resources/helpers/if-is-reference';
 import ifShowBreadcrumbsHelper from './resources/helpers/if-show-breadcrumbs';
 import ifShowNamedAnchorsHelper from './resources/helpers/if-show-named-anchors';
 import ifShowPageTitleHelper from './resources/helpers/if-show-page-title';
@@ -15,6 +16,7 @@ import ifShowTypeHierarchyHelper from './resources/helpers/if-show-type-hierarch
 import indexSignatureTitleHelper from './resources/helpers/index-signature-title';
 import parameterTableHelper from './resources/helpers/parameter-table';
 import propertyTableHelper from './resources/helpers/property-table';
+import referenceMember from './resources/helpers/reference-member';
 import reflectionPathHelper from './resources/helpers/reflection-path';
 import reflectionTitleHelper from './resources/helpers/reflection-title';
 import relativeUrlHelper from './resources/helpers/relative-url';
@@ -58,6 +60,7 @@ export function registerHelpers(theme: MarkdownTheme) {
   declarationTitleHelper();
   escapeHelper();
   hierarchyHelper();
+  ifIsReference();
   ifShowBreadcrumbsHelper(theme);
   ifShowNamedAnchorsHelper(theme);
   ifShowPageTitleHelper(theme);
@@ -66,6 +69,7 @@ export function registerHelpers(theme: MarkdownTheme) {
   indexSignatureTitleHelper();
   parameterTableHelper();
   propertyTableHelper();
+  referenceMember();
   reflectionPathHelper();
   reflectionTitleHelper(theme);
   relativeUrlHelper(theme);

packages/typedoc-plugin-markdown/src/resources/helpers/if-is-reference.ts

@@ -0,0 +1,16 @@
+import * as Handlebars from 'handlebars';
+import { DeclarationReflection, ReferenceReflection } from 'typedoc';
+
+export default function () {
+  Handlebars.registerHelper(
+    'ifIsReference',
+    function (
+      this: DeclarationReflection | ReferenceReflection,
+      options: Handlebars.HelperOptions,
+    ) {
+      return this instanceof ReferenceReflection
+        ? options.fn(this)
+        : options.inverse(this);
+    },
+  );
+}

packages/typedoc-plugin-markdown/src/resources/helpers/reference-member.ts

@@ -0,0 +1,25 @@
+import * as Handlebars from 'handlebars';
+import { ReferenceReflection } from 'typedoc';
+
+export default function () {
+  Handlebars.registerHelper(
+    'referenceMember',
+    function (this: ReferenceReflection) {
+      const referenced = this.tryGetTargetReflectionDeep();
+
+      if (!referenced) {
+        return `Re-exports ${this.name}`;
+      }
+
+      if (this.name === referenced.name) {
+        return `Re-exports [${
+          referenced.name
+        }](${Handlebars.helpers.relativeURL(referenced.url)})`;
+      }
+
+      return `Renames and re-exports [${
+        referenced.name
+      }](${Handlebars.helpers.relativeURL(referenced.url)})`;
+    },
+  );
+}

packages/typedoc-plugin-markdown/src/resources/partials/member.hbs

@@ -24,15 +24,15 @@
 
 {{else}}
 
-{{#if isReference}}
+{{#ifIsReference}}
 
-{{> member.reference}}
+{{referenceMember}}
 
 {{else}}
 
 {{> member.declaration}}
 
-{{/if}}
+{{/ifIsReference}}
 
 {{/if}}
 
@@ -42,4 +42,4 @@
 {{#unless hasOwnDocument}}
 ___
 {{/unless}}
-{{/unless}}
+{{/unless}}