Typesense

セットアップアンカーリンクをコピー

Fumadocs CLI を使うと、セットアップを自動で行えます。検索ダイアログ、static.json ルート、およびビルドのたびに検索インデックスを同期するスクリプトが作成されます。

npx @fumadocs/cli feature search --provider typesense

または手動で設定する場合:

1. Typesense Search を統合します。

2. 検索ダイアログコンポーネントを作成します。

   テキストをコピー

   'use client';
   import {
     SearchDialog,
     SearchDialogClose,
     SearchDialogContent,
     SearchDialogFooter,
     SearchDialogHeader,
     SearchDialogIcon,
     SearchDialogInput,
     SearchDialogList,
     SearchDialogOverlay,
     type SharedProps,
   } from 'fumadocs-ui/components/dialog/search';
   import { useI18n } from 'fumadocs-ui/contexts/i18n';
   import { Client } from 'typesense';
   import { useTypesenseSearch } from 'typesense-fumadocs-adapter/client';
   
   const client = new Client({
     nodes: [{ url: 'YOUR_TYPESENSE_SERVER_URL' }],
     apiKey: 'YOUR_TYPESENSE_SEARCH_ONLY_API_KEY',
   });
   
   export default function TypesenseSearchDialog(props: SharedProps) {
     const { locale } = useI18n(); // 任意
     const { search, setSearch, query } = useTypesenseSearch({
       typesenseCollectionName: 'docs',
       locale,
       legacy: false, // 任意。fumadocs-ui のバージョンが 16.6.0 未満の場合は true に設定します
       client,
     });
   
     return (
       <SearchDialog
         search={search}
         onSearchChange={setSearch}
         isLoading={query.isLoading}
         {...props}
       >
         <SearchDialogOverlay />
         <SearchDialogContent>
           <SearchDialogHeader>
             <SearchDialogIcon />
             <SearchDialogInput />
             <SearchDialogClose />
           </SearchDialogHeader>
           <SearchDialogList items={query.data !== 'empty' ? query.data : null} />
           <SearchDialogFooter>
             <div className="w-full text-right text-xs text-fd-muted-foreground">
               <a href="https://typesense.org" rel="noreferrer noopener" target="_blank">
                 Search powered by Typesense
               </a>
             </div>
           </SearchDialogFooter>
         </SearchDialogContent>
       </SearchDialog>
     );
   }

検索ダイアログを置き換えるアンカーリンクをコピー

プロバイダーコンポーネントはすでに src/components/search.tsx を <RootProvider /> に渡しているため、このファイルを置き換えるだけで済みます。

import { navigate } from 'astro:transitions/client';
import type { ReactNode } from 'react';
import { RootProvider } from 'fumadocs-ui/provider/astro';
import SearchDialog from '@/components/search';

export interface ProviderProps {
  pathname: string;
  params: Record<string, string | undefined>;
  children?: ReactNode;
}

export function Provider({ pathname, params, children }: ProviderProps) {
  return (
    <RootProvider
      pathname={pathname}
      params={params}
      navigate={navigate}
      search={{ SearchDialog }}
    >
      {children}
    </RootProvider>
  );
}

タグフィルターアンカーリンクをコピー

必要に応じて、検索結果をタグで絞り込むための UI を追加できます。検索サーバー側でタグフィルターを設定したうえで、以下を追加してください。

'use client';

import {
  SearchDialog,
  SearchDialogContent,
  SearchDialogFooter,
  SearchDialogOverlay,
  type SharedProps,
  TagsList,
  TagsListItem,
} from 'fumadocs-ui/components/dialog/search';
import { useState } from 'react';
import { useTypesenseSearch } from 'typesense-fumadocs-adapter/client';

export default function TypesenseSearchDialog(props: SharedProps) {
  const [tag, setTag] = useState<string | undefined>();
  const { search, setSearch, query } = useTypesenseSearch({
    tag, 
    // その他のオプション...
  });

  return (
    <SearchDialog>
      <SearchDialogOverlay />
      <SearchDialogContent>
        ...
        <SearchDialogFooter className="flex flex-row">
          <TagsList tag={tag} onTagChange={setTag}>
            <TagsListItem value="my-value">My Value</TagsListItem>
          </TagsList>
        </SearchDialogFooter>
      </SearchDialogContent>
    </SearchDialog>
  );
}