跳至內容
Fumadocs

Meilisearch

搭配 Fumadocs UI 使用 Meilisearch。

設定

Fumadocs CLI 可以幫您完成設定,包括建立搜尋對話方塊、static.json 路由,以及在每次建置後同步搜尋索引的指令碼:

npx @fumadocs/cli feature search --provider meilisearch

或手動設定:

  1. 整合 Meilisearch。

  2. 建立搜尋對話方塊,並將 host 和 apiKey 替換為您的主機 URL 與搜尋 API 金鑰。

    components/search.tsx
    'use client';
    import { Meilisearch } from 'meilisearch';
    import {
      SearchDialog,
      SearchDialogClose,
      SearchDialogContent,
      SearchDialogFooter,
      SearchDialogHeader,
      SearchDialogIcon,
      SearchDialogInput,
      SearchDialogList,
      SearchDialogOverlay,
      type SharedProps,
    } from 'fumadocs-ui/components/dialog/search';
    import { useMeilisearch } from 'fumadocs-core/search/client';
    import { useI18n } from 'fumadocs-ui/contexts/i18n';
    
    const client = new Meilisearch({
      host: 'replace me',
      apiKey: 'replace me',
    });
    
    export default function CustomSearchDialog(props: SharedProps) {
      const { locale } = useI18n(); // (optional) for i18n
      const search = useMeilisearch({
        client,
        indexName: 'docs',
        locale,
      });
    
      return (
        <SearchDialog {...search} {...props}>
          <SearchDialogOverlay />
          <SearchDialogContent>
            <SearchDialogHeader>
              <SearchDialogIcon />
              <SearchDialogInput />
              <SearchDialogClose />
            </SearchDialogHeader>
            <SearchDialogList />
            <SearchDialogFooter>
              <a
                href="https://www.meilisearch.com"
                rel="noreferrer noopener"
                className="ms-auto text-xs text-fd-muted-foreground"
              >
                Search powered by Meilisearch
              </a>
            </SearchDialogFooter>
          </SearchDialogContent>
        </SearchDialog>
      );
    }
    

替換搜尋對話方塊

請在根路由中,將您的搜尋對話方塊傳入 <RootProvider />:

src/routes/__root.tsx
import { createRootRoute, HeadContent, Outlet, Scripts } from '@tanstack/react-router';
import { RootProvider } from 'fumadocs-ui/provider/tanstack';
import SearchDialog from '@/components/search';

export const Route = createRootRoute({
  component: RootComponent,
});

function RootComponent() {
  return (
    <html suppressHydrationWarning>
      <head>
        <HeadContent />
      </head>
      <body className="flex flex-col min-h-screen">
        <RootProvider search={{ SearchDialog }}>
          <Outlet />
        </RootProvider>
        <Scripts />
      </body>
    </html>
  );
}

標籤篩選

您也可以視需要加入依標籤篩選結果的 UI。請先在文件上設定標籤篩選,再加入以下內容:

'use client';

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

export default function CustomSearchDialog(props: SharedProps) {
  const [tag, setTag] = useState<string | undefined>();
  const search = useMeilisearch({
    tag, 
    // 其他選項……
  });

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

How is this guide?

最後更新於