feat: added ability to add canonical url to frontmatter (#1588)

fern-api · Oct 2, 2024 · dd01309 · dd01309
1 parent 19fd1d7
commit dd01309
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 0 deletions.
diff --git a/fern/apis/fdr/definition/docs/latest/frontmatter.yml b/fern/apis/fdr/definition/docs/latest/frontmatter.yml
@@ -63,6 +63,9 @@ types:
         availability: deprecated
         type: optional<string>
         docs: Use subtitle instead.
+      canonical-url:
+        type: optional<string>
+        docs: The canonical URL of the page. This is used for the <link rel="canonical"> tag in the HTML.
 
   Layout:
     enum:

diff --git a/.../generated/api/resources/docs/resources/latest/resources/frontmatter/types/Frontmatter.ts b/.../generated/api/resources/docs/resources/latest/resources/frontmatter/types/Frontmatter.ts
diff --git a/packages/ui/app/src/seo/getSeoProp.ts b/packages/ui/app/src/seo/getSeoProp.ts
@@ -84,6 +84,11 @@ export function getSeoProps(
         const page = pages[pageId];
         if (page != null) {
             const { data: frontmatter, content } = getFrontmatter(page.markdown);
+
+            if (frontmatter["canonical-url"] != null) {
+                seo.canonical = frontmatter["canonical-url"];
+            }
+
             ogMetadata = { ...ogMetadata, ...frontmatter };
 
             // retrofit og:image, preferring og:image

diff --git a/...enerated/api/resources/docs/resources/latest/resources/frontmatter/types/Frontmatter.d.ts b/...enerated/api/resources/docs/resources/latest/resources/frontmatter/types/Frontmatter.d.ts