Skip to content

armgit / ui

Public Imported from GitHub
0
TypeScript

Use canonical site URLs for metadata

Andrew Luobca60b9e204e
diff --git a/apps/v4/.env.example b/apps/v4/.env.example
index 4b776c2..8beb42e 100644
--- a/apps/v4/.env.example
+++ b/apps/v4/.env.example
@@ -1,4 +1,3 @@
NEXT_PUBLIC_V0_URL=https://v0.dev
-NEXT_PUBLIC_APP_URL=http://localhost:4000/ui
NEXT_PUBLIC_BASE_PATH=/ui
NEXT_PUBLIC_ASSET_PREFIX=/ui-static
diff --git a/apps/v4/app/(app)/(root)/page.tsx b/apps/v4/app/(app)/(root)/page.tsx
index 3ab348a..75dfe72 100644
--- a/apps/v4/app/(app)/(root)/page.tsx
+++ b/apps/v4/app/(app)/(root)/page.tsx
@@ -1,6 +1,7 @@
import { type Metadata } from "next"
import Link from "next/link"
+import { absoluteUrl } from "@/lib/utils"
import { Button } from "@/components/ui/button"
import {
PageActions,
@@ -26,7 +27,11 @@ export const revalidate = false
export const metadata: Metadata = {
title,
description,
+ alternates: {
+ canonical: absoluteUrl("/"),
+ },
openGraph: {
+ url: absoluteUrl("/"),
images: [
{
url: `/og?title=${encodeURIComponent(
diff --git a/apps/v4/app/(app)/blocks/layout.tsx b/apps/v4/app/(app)/blocks/layout.tsx
index 10ca8d8..471d349 100644
--- a/apps/v4/app/(app)/blocks/layout.tsx
+++ b/apps/v4/app/(app)/blocks/layout.tsx
@@ -1,6 +1,7 @@
import { type Metadata } from "next"
import Link from "next/link"
+import { absoluteUrl } from "@/lib/utils"
import { Button } from "@/components/ui/button"
import {
PageActions,
@@ -16,7 +17,11 @@ const description =
export const metadata: Metadata = {
title,
description,
+ alternates: {
+ canonical: absoluteUrl("/blocks"),
+ },
openGraph: {
+ url: absoluteUrl("/blocks"),
images: [
{
url: `/og?title=${encodeURIComponent(
diff --git a/apps/v4/app/(app)/docs/[[...slug]]/page.tsx b/apps/v4/app/(app)/docs/[[...slug]]/page.tsx
index a61d298..ccdd578 100644
--- a/apps/v4/app/(app)/docs/[[...slug]]/page.tsx
+++ b/apps/v4/app/(app)/docs/[[...slug]]/page.tsx
@@ -39,6 +39,9 @@ export async function generateMetadata(props: {
return {
title: doc.title,
description: doc.description,
+ alternates: {
+ canonical: absoluteUrl(page.url),
+ },
openGraph: {
title: doc.title,
description: doc.description,
diff --git a/apps/v4/app/(view)/view/blocks/[block]/page.tsx b/apps/v4/app/(view)/view/blocks/[block]/page.tsx
index a14818d..b6984f6 100644
--- a/apps/v4/app/(view)/view/blocks/[block]/page.tsx
+++ b/apps/v4/app/(view)/view/blocks/[block]/page.tsx
@@ -2,6 +2,7 @@ import type { Metadata } from "next"
import { notFound } from "next/navigation"
import { getPdfViewerBlock, PDF_VIEWER_BLOCKS } from "@/lib/pdf-viewer-blocks"
+import { absoluteUrl } from "@/lib/utils"
import { PdfViewerBlockFullscreen } from "@/components/pdf-viewer-block-fullscreen"
export const dynamic = "force-static"
@@ -27,6 +28,12 @@ export async function generateMetadata({
return {
title: block.title,
description: block.description,
+ alternates: {
+ canonical: absoluteUrl(`/view/blocks/${block.id}`),
+ },
+ openGraph: {
+ url: absoluteUrl(`/view/blocks/${block.id}`),
+ },
}
}
diff --git a/apps/v4/app/layout.tsx b/apps/v4/app/layout.tsx
index 4c6feac..bebf2bf 100644
--- a/apps/v4/app/layout.tsx
+++ b/apps/v4/app/layout.tsx
@@ -20,7 +20,7 @@ export const metadata: Metadata = {
default: siteConfig.name,
template: `%s - ${siteConfig.name}`,
},
- metadataBase: new URL(process.env.NEXT_PUBLIC_APP_URL ?? siteConfig.url),
+ metadataBase: new URL(siteConfig.url),
description: siteConfig.description,
keywords: ["Next.js", "React", "Tailwind CSS", "Documents", "Components"],
authors: [
@@ -33,13 +33,13 @@ export const metadata: Metadata = {
openGraph: {
type: "website",
locale: "en_US",
- url: process.env.NEXT_PUBLIC_APP_URL ?? siteConfig.url,
+ url: siteConfig.url,
title: siteConfig.name,
description: siteConfig.description,
siteName: siteConfig.name,
images: [
{
- url: `${process.env.NEXT_PUBLIC_APP_URL ?? siteConfig.url}/opengraph-image.png`,
+ url: siteConfig.ogImage,
width: 1200,
height: 630,
alt: siteConfig.name,
@@ -50,9 +50,7 @@ export const metadata: Metadata = {
card: "summary_large_image",
title: siteConfig.name,
description: siteConfig.description,
- images: [
- `${process.env.NEXT_PUBLIC_APP_URL ?? siteConfig.url}/opengraph-image.png`,
- ],
+ images: [siteConfig.ogImage],
},
icons: {
icon: [
diff --git a/apps/v4/app/robots.ts b/apps/v4/app/robots.ts
new file mode 100644
index 0000000..736d64a
--- /dev/null
+++ b/apps/v4/app/robots.ts
@@ -0,0 +1,15 @@
+import type { MetadataRoute } from "next"
+
+import { absoluteUrl } from "@/lib/utils"
+
+export default function robots(): MetadataRoute.Robots {
+ return {
+ rules: [
+ {
+ userAgent: "*",
+ allow: "/",
+ },
+ ],
+ sitemap: absoluteUrl("/sitemap.xml"),
+ }
+}
diff --git a/apps/v4/app/sitemap.ts b/apps/v4/app/sitemap.ts
new file mode 100644
index 0000000..babd31d
--- /dev/null
+++ b/apps/v4/app/sitemap.ts
@@ -0,0 +1,32 @@
+import type { MetadataRoute } from "next"
+
+import {
+ getAllPagesFromFolder,
+ type PageTreeNode,
+ type PageTreePage,
+} from "@/lib/page-tree"
+import { source } from "@/lib/source"
+import { absoluteUrl } from "@/lib/utils"
+
+function getDocsPages(nodes: PageTreeNode[]): PageTreePage[] {
+ return nodes.flatMap((node) => {
+ if (node.type === "page") return [node]
+ if (node.type === "folder") return getAllPagesFromFolder(node)
+
+ return []
+ })
+}
+
+export default function sitemap(): MetadataRoute.Sitemap {
+ const docsPages = getDocsPages(source.pageTree.children)
+
+ const staticRoutes: MetadataRoute.Sitemap = [
+ { url: absoluteUrl("/") },
+ { url: absoluteUrl("/blocks") },
+ ]
+ const docsRoutes: MetadataRoute.Sitemap = docsPages.map((page) => ({
+ url: absoluteUrl(page.url),
+ }))
+
+ return [...staticRoutes, ...docsRoutes]
+}
diff --git a/apps/v4/lib/config.ts b/apps/v4/lib/config.ts
index 7f3c85d..7544eae 100644
--- a/apps/v4/lib/config.ts
+++ b/apps/v4/lib/config.ts
@@ -1,9 +1,9 @@
-const appUrl = process.env.NEXT_PUBLIC_APP_URL ?? "https://www.extend.ai/ui"
+const canonicalUrl = "https://www.extend.ai/ui"
export const siteConfig = {
name: "Extend UI",
- url: appUrl,
- ogImage: `${appUrl}/opengraph-image.png`,
+ url: canonicalUrl,
+ ogImage: `${canonicalUrl}/opengraph-image.png`,
description:
"Open source UI primitives for building document processing products with viewers, review surfaces, and validation workflows.",
links: {
diff --git a/apps/v4/lib/utils.ts b/apps/v4/lib/utils.ts
index ecdc38e..f1005a8 100644
--- a/apps/v4/lib/utils.ts
+++ b/apps/v4/lib/utils.ts
@@ -8,5 +8,7 @@ export function cn(...inputs: ClassValue[]): string {
}
export function absoluteUrl(path: string): string {
- return `${siteConfig.url}${path}`
+ const normalizedPath = path.startsWith("/") ? path : `/${path}`
+
+ return `${siteConfig.url}${normalizedPath === "/" ? "" : normalizedPath}`
}