Fix link resolution for monorepo readmes

Resolves #2029
TypeStrong · Aug 13, 2022 · 295c97f · 295c97f
1 parent 23ea426
commit 295c97f
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Unreleased
 
+### Bug Fixes
+
+-   Readme files within monorepos now have `@link` tags resolved, #2029.
+
 ## v0.23.10 (2022-07-31)
 
 ### Features

diff --git a/src/lib/converter/plugins/LinkResolverPlugin.ts b/src/lib/converter/plugins/LinkResolverPlugin.ts
@@ -2,6 +2,7 @@ import { Component, ConverterComponent } from "../components";
 import type { Context } from "../../converter";
 import { ConverterEvents } from "../converter-events";
 import { BindOption, ValidationOptions } from "../../utils";
+import { DeclarationReflection } from "../../models";
 
 /**
  * A plugin that resolves `{@link Foo}` tags.
@@ -24,6 +25,16 @@ export class LinkResolverPlugin extends ConverterComponent {
             if (reflection.comment) {
                 context.converter.resolveLinks(reflection.comment, reflection);
             }
+
+            if (
+                reflection instanceof DeclarationReflection &&
+                reflection.readme
+            ) {
+                reflection.readme = context.converter.resolveLinks(
+                    reflection.readme,
+                    reflection
+                );
+            }
         }
 
         if (context.project.readme) {