OG image generation

Took 54 minutes

config.json

@@ -1,5 +1,6 @@
 {
   "siteName": "Pulse App",
+  "ogApiUrl": "https://docs.pulseapp.cc/api/og?title={title}",
   "metadata": {
     "title": {
       "default": "Pulse Docs",

package.json

@@ -20,6 +20,7 @@
     "@radix-ui/react-separator": "^1.1.0",
     "@radix-ui/react-slot": "^1.1.0",
     "@radix-ui/react-tooltip": "^1.1.3",
+    "@vercel/og": "^0.6.3",
     "class-variance-authority": "^0.7.0",
     "clsx": "^2.1.1",
     "cmdk": "1.0.0",

src/app/[[...slug]]/page.tsx

@@ -14,6 +14,7 @@ import { Metadata } from "next";
 import Embed from "@/components/embed";
 import DocsFooter from "@/components/docs-footer";
 import OnThisPage from "@/components/on-this-page";
+import config from "@/config";
 
 /**
  * The page to render the documentation markdown content.
@@ -110,6 +111,7 @@ export const generateMetadata = async ({
             return Embed({
                 title: content.title,
                 description: content.summary,
+                thumbnail: config.ogApiUrl.replace("{title}", content.title),
             });
         }
     }

src/app/api/og/route.tsx

@@ -0,0 +1,30 @@
+import { ImageResponse } from "next/og";
+import config from "@/config";
+
+export const GET = async (request: Request) => {
+    const { searchParams } = new URL(request.url);
+    const title: string | undefined = searchParams.has("title")
+        ? searchParams.get("title")?.slice(0, 100)
+        : "Hello World (:";
+
+    return new ImageResponse(
+        (
+            <div tw="w-full h-full flex flex-col justify-center items-center bg-black/95 text-white">
+                {/* Logo */}
+                <img
+                    src={(config.metadata.openGraph?.images as any)[0].url}
+                    alt={`${config.siteName} Logo`}
+                    width={96}
+                    height={96}
+                />
+
+                {/* Title */}
+                <h1 tw="text-5xl font-bold">{title}</h1>
+            </div>
+        ),
+        {
+            width: 1200,
+            height: 630,
+        }
+    );
+};

src/app/types/config.ts

@@ -6,6 +6,11 @@ export type Config = {
      */
     siteName: string;
 
+    /**
+     * The URL to use for generating OG images.
+     */
+    ogApiUrl: string;
+
     /**
      * The metadata for this app.
      */

src/components/embed.tsx

@@ -13,6 +13,11 @@ type EmbedProps = {
      * The description of the embed.
      */
     description: string;
+
+    /**
+     * The optional thumbnail image of the embed.
+     */
+    thumbnail?: string | undefined;
 };
 
 /**
@@ -21,13 +26,25 @@ type EmbedProps = {
  * @param props the embed props
  * @returns the embed jsx
  */
-const Embed = ({ title, description }: EmbedProps): Metadata => {
+const Embed = ({ title, description, thumbnail }: EmbedProps): Metadata => {
     return {
         title: title,
         openGraph: {
             title: `${title}`,
             description: description,
+            ...(thumbnail && {
+                images: [
+                    {
+                        url: thumbnail,
+                    },
+                ],
+            }),
         },
+        ...(thumbnail && {
+            twitter: {
+                card: "summary_large_image",
+            },
+        }),
     };
 };
 export default Embed;