Skip to Content
Fumadocs

Takumi

Integrate Takumi for framework agnostic and fast metadata image generation.

Installation

npm install takumi-js

Metadata Image

Add a function that returns the image URL of a page, and reference the image in the metadata of docs pages:

export const docsImageRoute = '/og/docs';

export function getPageImagePath(slugs: string[], locale?: string) {
  return (
    '/' + [locale, ...docsImageRoute.split('/'), ...slugs, 'image.webp'].filter(Boolean).join('/')
  );
}

The image of /docs/my-page is at /og/docs/my-page/image.webp, since WebP images are smaller than PNG ones. To generate PNG, use image.png and format: 'png' instead.

Then create a route to generate the images:

import { source } from '@/lib/source';
import { generateOGImage } from 'fumadocs-ui/og/takumi';
import type { Route } from './+types/docs.og';

export function loader({ params }: Route.LoaderArgs) {
  const slugs = params['*']
    .split('/')
    .filter((v) => v.length > 0)
    .slice(0, -1);
  const page = source.getPage(slugs);

  if (!page) throw new Response(undefined, { status: 404 });

  return generateOGImage({
    title: page.data.title,
    description: page.data.description,
    site: 'My App',
    format: 'webp',
  });
}

Takumi bundles the full-axis (100-900) Geist and Geist Mono fonts, so no font setup is needed.

See Takumi's Documentation for advanced usage.

Other Templates

See Takumi Templates for the available templates.

How is this guide?