Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ogify.dev/llms.txt

Use this file to discover all available pages before exploring further.

Important: Add OGify packages to serverExternalPackages in your next.config.js:
const nextConfig = {
  ...
  experimental: {
    serverExternalPackages: ["@ogify/core", "@ogify/templates"],
  },
  ...
};

module.exports = nextConfig;
This prevents Next.js from bundling OGify packages, which is necessary for proper font loading and image generation.
Next.js App Router provides two distinct ways to generate Open Graph images: using File Conventions (opengraph-image.ts) or using Route Handlers. Next.js has built-in support for generating images using opengraph-image.ts. This maps directly to OGify’s renderer.
1

Create opengraph-image.ts

Place this file in any route segment (e.g., app/opengraph-image.ts or app/posts/[slug]/opengraph-image.ts).
import { createRenderer } from '@ogify/core';
import template from '@ogify/templates/basic';
import type { TemplateParams } from '@ogify/templates/basic';

// Configure the renderer (outside the handler for caching)
const renderer = createRenderer<{ basic: TemplateParams }>({
  templates: { basic: template },
});

export const size = {
  width: 1200,
  height: 630,
};

export const contentType = 'image/png';

export default async function OgImage() {
  // Generate the image buffer
  const buffer = await renderer.renderToImage('basic', {
    title: 'My Page Title',
    subtitle: 'Generated via opengraph-image.ts',
    layout: 'centered',
  });

  // Return the buffer as a Response
  return new Response(buffer, {
    headers: {
      'Content-Type': 'image/png',
    },
  });
}
While Next.js provides ImageResponse, OGify returns a standard Buffer, which you can simply return in a standard Response object.

​
Option 2: Route Handlers

If you need a dynamic endpoint (e.g., /api/og?title=...) that enables you to generate images on demand for various pages, use a Route Handler.
1

Create the Route Handler

Create app/api/og/route.ts:
import { createRenderer } from '@ogify/core';
import template from '@ogify/templates/basic';
import type { TemplateParams } from '@ogify/templates/basic';

const renderer = createRenderer<{ basic: TemplateParams }>({
  templates: { basic: template },
});

export async function GET(request: Request) {
  const { searchParams } = new URL(request.url);
  const title = searchParams.get('title') || 'Hello Next.js';

  const imageBuffer = await renderer.renderToImage('basic', {
    title,
    layout: 'centered',
  });

  return new Response(imageBuffer, {
    headers: {
      'Content-Type': 'image/png',
    },
  });
}
2

Use in Metadata

// app/page.tsx
export const metadata = {
  openGraph: {
    images: ['/api/og?title=My Page Title'],
  },
};