搜尋
為您的文件網站實作文件搜尋功能
搜尋 UI
若要了解如何自訂文件搜尋的 UI，請參閱搜尋 UI。
搜尋用戶端
您可以依據所使用的搜尋引擎，選擇並設定搜尋用戶端，預設為 ZBSearch。
ZBSearch（預設）
以 ZBSearch 為基礎的預設搜尋引擎。
Algolia
在 Fumadocs UI 中使用 Algolia。
FlexSearch
快速且輕量的搜尋引擎。
Meilisearch
搭配 Fumadocs UI 使用 Meilisearch。
Mixedbread
在 Fumadocs UI 中使用 Mixedbread。
Orama Cloud
在 Fumadocs UI 中使用 Orama Cloud。
Typesense
搭配 Fumadocs UI 使用 Typesense。
自訂搜尋
適用於其他搜尋方案。
搜尋 Hook
搜尋用戶端提供了 React hook，例如 useFetchSearch() 和 useAlgoliaSearch()，可回傳 <SearchDialog /> 所需的 props：
import { useFetchSearch } from 'fumadocs-core/search/client';
const search = useFetchSearch();
<SearchDialog {...search} {...props} />;除了用於搜尋輸入框的 search 與 onSearchChange 之外，這些 Hook 還會回傳：
data：最近一次成功的搜尋，在重新搜尋期間以及發生錯誤後都會保留。items：該次搜尋的結果，其內容也會解析為 hast，並以hastContent提供。表格的各列會歸入同一個table項目。query：該次搜尋所使用的查詢字串。
error：最近一次搜尋失敗時會設定此值。isLoading：針對search的搜尋是否仍在進行中。
若要使用其他搜尋引擎，請將經過 memoize 的搜尋函式傳入 experimental_useSearch()；當該函式變更時，便會重新搜尋。
'use client';
import { useCallback } from 'react';
import { experimental_useSearch } from 'fumadocs-core/search/client';
import type { SortedResult } from 'fumadocs-core/search';
export function useMySearch(locale: string) {
const search = useCallback(
async (query: string): Promise<SortedResult[]> => {
const res = await fetch(`/api/my-search?${new URLSearchParams({ query, locale })}`);
return res.json();
},
[locale],
);
return experimental_useSearch(search);
}社群整合
以下是由社群維護的整合清單。
How is this guide?
最後更新於
General Translation
Ferry Health
assistant-ui
Inkeep