Takumi

安裝

npm install takumi-js

中繼資料圖片

新增一個回傳頁面圖片 URL 的函式，並在文件頁面的中繼資料中引用該圖片：

import { createGetUrl } from 'fumadocs-core/source';

const getImageUrl = createGetUrl('/og/docs');

export function getPageImageUrl(page: { slugs: string[]; locale?: string }) {
  const segments = [...page.slugs, 'image.webp'];

  return { segments, url: getImageUrl(segments, page.locale) };
}

import { getPageImageUrl } from '@/lib/shared';

// 在您的頁面元件中的某處
return (
  <DocsPage toc={page.data.toc}>
    <meta property="og:image" content={getPageImageUrl(page).url} />
    {/* ... */}
  </DocsPage>
);

/docs/my-page 的圖片位於 /og/docs/my-page/image.webp，因為 WebP 圖片的檔案比 PNG 小。若要產生 PNG，請改用 image.png 與 format: 'png'。

接著建立用來產生圖片的路由：

src/pages/_api/og/docs/[...slugs]/image.webp.tsx

import { source } from '@/lib/source';
import { generateOGImage } from 'fumadocs-ui/og/takumi';
import { ApiContext } from 'waku/router';

export async function GET(_: Request, { params }: ApiContext<'/og/docs/[...slugs]/image.webp'>) {
  const page = source.getPage(params.slugs);

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

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

export async function getConfig() {
  const pages = source
    .generateParams()
    .map((item) => (item.lang ? [item.lang, ...item.slug] : item.slug));

  return {
    render: 'static' as const,
    staticPaths: pages,
  } as const;
}

Takumi 已內建完整字重軸 (100-900) 的 Geist 與 Geist Mono 字型，無須另外設定字型。

進階用法請參閱 Takumi 官方文件。

其他範本

可用的範本請參閱 Takumi 範本。

安裝複製錨點連結

中繼資料圖片複製錨點連結

其他範本複製錨點連結

本頁目錄

安裝

中繼資料圖片

其他範本