Sanity

概覽

Fumadocs 提供官方整合，可簡化 Sanity CMS 的設定流程。

您可以在 GitHub 上查看我們的 Sanity 範例。

設定

本指南假設您已依照 Sanity 官方文件完成設定。

資料型別

請執行以下指令來初始化內容型別。

npx @fumadocs/cli add sanity/base

您也可以執行 npx @fumadocs/cli add，瀏覽並安裝其他 Sanity 預設組合。

註冊已安裝的類型：

import { docsType, blockContent, callout, card, cards } from '@/lib/sanity/base';

export const schemaTypes = [blockContent, callout, card, cards, docsType];

內容載入器

安裝此整合：

npm i @fumadocs/sanity

使用 Sanity 用戶端建立來源：

lib/source.ts

import { dynamicLoader } from 'fumadocs-core/source';
import { createSanitySource } from '@fumadocs/sanity';
// Sanity 用戶端
import { client } from '@/sanity/lib/client';
// 產生的型別
import type { Docs } from '@/sanity/types';

const source = dynamicLoader(
  createSanitySource<Docs>({
    client,
    docType: 'docs',
  }),
  {
    baseUrl: '/docs',
  },
);

export async function getSource() {
  return source.get();
}

接著使用 getSource() 函式算繪頁面：

src/routes/docs/$.tsx

import { createFileRoute, notFound } from '@tanstack/react-router';
import { createServerFn } from '@tanstack/react-start';
import { useFumadocsLoader } from 'fumadocs-core/source/client';
import { DocsLayout } from 'fumadocs-ui/layouts/docs';
import { DocsBody, DocsDescription, DocsPage, DocsTitle } from 'fumadocs-ui/layouts/docs/page';
import { renderToc } from '@fumadocs/sanity/client';
import { getSource } from '@/lib/source';
import { CustomPortableText } from '@/components/sanity';
import type { PortableTextBlock } from '@portabletext/react';

// server function 回傳結果的型別檢查無法驗證 Portable Text，
// 因此需將其註冊為可序列化型別（若無法解析 `@tanstack/router-core`，請先安裝該套件）
declare module '@tanstack/router-core' {
  interface SerializableExtensions {
    portableTextBlock: PortableTextBlock;
  }
}

export const Route = createFileRoute('/docs/$')({
  component: Page,
  loader: ({ params }) => serverLoader({ data: params._splat?.split('/') ?? [] }),
});

const serverLoader = createServerFn({
  method: 'GET',
})
  .validator((slugs: string[]) => slugs)
  .handler(async ({ data: slugs }) => {
    const source = await getSource();
    const page = source.getPage(slugs);
    if (!page) throw notFound();

    const { title, description, _toc, body } = await page.data.load();
    return {
      title,
      description,
      toc: _toc,
      body,
      pageTree: await source.serializePageTree(source.getPageTree()),
    };
  });

function Page() {
  const { title, description, toc, body, pageTree } = useFumadocsLoader(Route.useLoaderData());

  return (
    <DocsLayout tree={pageTree}>
      <DocsPage toc={renderToc({ toc, render: (block) => <CustomPortableText value={block} /> })}>
        <DocsTitle>{title}</DocsTitle>
        <DocsDescription>{description}</DocsDescription>
        <DocsBody>
          <CustomPortableText value={body!} />
        </DocsBody>
      </DocsPage>
    </DocsLayout>
  );
}

完成

在 Studio 編輯器中建立 docs 類型的文件後，這些文件就會出現在 docs 路由中。

概覽複製錨點連結

設定複製錨點連結

資料型別複製錨點連結

內容載入器複製錨點連結

完成複製錨點連結

本頁目錄

概覽

設定

資料型別

內容載入器

完成