AI 與 LLM
在 Fumadocs 中整合 AI 功能。
供 LLM 使用的文件
以 Markdown 格式提供您的文件,供 LLM 與 AI 代理使用:
npx @fumadocs/cli feature llms它會為您的 docs 集合啟用處理後的 Markdown,在 lib/source.ts 中加入 docsLlms,並提供下方的檔案。若您偏好手動設定,可參考以下列出的產生檔案。
docsLlms
llms() 會為 LLM 算繪您的文件。renderPage 會將單一頁面轉換為 Markdown,依據的是處理後的文件,而非原始檔案內容:
import { llms } from 'fumadocs-core/source';
export const docsLlms = llms(source, {
renderPage: async (page) => `# ${page.data.title} (${page.url})
${await page.data.getText('processed')}`,
});
| 方法 | 輸出 |
|---|---|
index(lang?) | llms.txt 索引,依頁面樹建立 |
page(page) | 單一頁面,以 renderPage 算繪 |
full(lang?) | 以 renderPage 算繪後合併的所有頁面 |
files() | 供 AI 代理使用的檔案的路徑 |
serve(path) | 指定路徑上檔案的回應 |
renderPage 為必要項目
只有在傳入 renderPage 時,才能使用 page()、full()、files() 與 serve(),因為
Fumadocs 無從得知您的內容來源如何提供 Markdown。
renderPage 會讀取頁面處理後的 Markdown,因此請啟用 includeProcessedMarkdown:
import { defineDocs } from 'fumadocs-mdx/config';
export const docs = defineDocs({
dir: 'content/docs',
docs: {
postprocess: {
includeProcessedMarkdown: true,
},
},
});
MDX 元件會以 JSX 語法呈現。若要將其算繪為 Markdown 形式,請將您的 MDX 元件作為頁面 props 傳入。
@fumadocs/local-md 等執行階段內容來源會隨需解析。只要傳入其 getSource,CLI 就會產生相同的檔案:
export const docsLlms = llms(getSource, {
renderPage: (page) => `# ${page.data.title} (${page.url})
${page.data.content}`,
});使用 getSource 時,index() 與 indexNode() 會回傳 Promise,而不是字串。
檔案
CLI 會為 AI 代理提供以下檔案:
/llms.txt:文件的索引,附有每個頁面 Markdown 版本的連結。/llms-full.txt:所有頁面的內容。<page>.md:單一頁面的 Markdown,例如/docs/ui.md。位於/的頁面則對應/index.md。<section>/llms-full.txt:某個區段的內容,例如/docs/ui/llms-full.txt。
若要將特定頁面 (例如草稿) 排除在這些檔案之外,請傳入 filter。llms.txt 仍會列出這些頁面,但改為連結至其 HTML 頁面:
export const docsLlms = llms(source, {
filter: (page) => page.slugs[0] !== 'drafts',
renderPage: async (page) => `# ${page.data.title}\n\n${await page.data.getText('processed')}`,
});在這些檔案中,renderUrl 會接收連結所指向檔案的路徑,例如頁面的 .md 檔案。
讀取頁面 HTML 的 AI 代理會透過 <head> 中的連結找到該頁面的 Markdown:
<link rel="alternate" type="text/markdown" href="/docs/ui.md" />區段
區段是頁面樹中擁有專屬 llms-full.txt 的資料夾,讓 AI 代理能逐段閱讀大型文件。預設情況下,每個根資料夾都是一個區段。在 llms.txt 中,該資料夾對應的那一行會連結到其所屬區段的 llms-full.txt。
若要自訂哪些資料夾作為區段,請傳入 section。它會接收一個資料夾,並回傳該資料夾是否為區段:
export const docsLlms = llms(source, {
// 所有含 index 頁面的資料夾
section: (folder) => folder.index !== undefined,
renderPage: async (page) => `# ${page.data.title}\n\n${await page.data.getText('processed')}`,
});在大型網站上,您可以收合區段,讓 llms.txt 保持簡短。收合的區段在 llms.txt 中只會列為一個連結,指向該區段專屬的 <section>/llms.txt,再由該檔案列出區段內的頁面:
export const docsLlms = llms(source, {
section: (folder) => (folder.root ? { collapse: true } : false),
renderPage: async (page) => `# ${page.data.title}\n\n${await page.data.getText('processed')}`,
});區段的檔案會透過其資料夾索引頁面的 URL 提供。若資料夾沒有索引頁面,則改用其頁面所在的 URL 目錄。當兩個資料夾共用同一個 URL 時 (例如資料夾群組) ,請傳入 asPath,讓其中一個改由另一個路徑提供,例如 { asPath: '/docs/guides' }。
路由
files() 會列出檔案的路徑,而 serve(path) 會回應位於該路徑的檔案,因此每個路由只需將請求路徑傳給 serve() 即可。
文件頁面 docs/$ 會比對 /docs 下的所有路徑,因此文件底下各檔案的路由需使用更明確的路徑,例如 docs/{$}.md:
import { createFileRoute } from '@tanstack/react-router';
import { docsLlms } from '@/lib/source';
export const Route = createFileRoute('/llms.txt')({
server: {
handlers: {
GET: async ({ request }) => (await docsLlms.serve(new URL(request.url).pathname)) ?? new Response(null, { status: 404 }),
},
},
});
若路徑沒有對應的檔案,serve() 會回傳 undefined,讓中介軟體能將請求繼續往下傳遞。使用 hideLocale: 'always' 時,URL 不會包含語系:請將語言作為 serve() 的第二個引數,以及 files() 的第一個引數傳入。
靜態輸出
在 SPA 模式下,請使用 Nitro 預先算繪這些檔案。TanStack Start 請求預先算繪的路徑時會加上結尾斜線,導致檔案的路由無法比對。Vite 載入設定時不會套用您的外掛,因此請使用 runnerImport 載入來源:
import { defineConfig, runnerImport } from 'vite';
import { fumadocsMdx } from 'fumadocs-mdx/vite';
import { nitro } from 'nitro/vite';
const { docsLlms } = (
await runnerImport<typeof import('./src/lib/source')>('./src/lib/source.ts', {
plugins: [fumadocsMdx()],
resolve: { tsconfigPaths: true },
})
).module;
export default defineConfig({
plugins: [
// 其他外掛
nitro({
prerender: { routes: await docsLlms.files() },
}),
],
});Accept
AI 代理可以透過 Accept 標頭要求取得 Markdown。
當請求偏好 Markdown 時,重新導向至該頁面的 Markdown:
import { createMiddleware, createStart } from '@tanstack/react-start';
import { redirect } from '@tanstack/react-router';
import { isMarkdownPreferred } from 'fumadocs-core/negotiation';
const llmMiddleware = createMiddleware().server(({ next, request }) => {
const url = new URL(request.url);
// 檔案路由會提供 `/docs/ui.md` 這類路徑
if (
url.pathname.startsWith('/docs') &&
!/\.(md|txt)$/.test(url.pathname) &&
isMarkdownPreferred(request)
) {
url.pathname += '.md';
throw redirect({ href: url.href, headers: { Vary: 'Accept' } });
}
return next();
});
export const startInstance = createStart(() => ({
requestMiddleware: [llmMiddleware],
}));同一個 URL 現在有兩種呈現形式,因此回應需要加上 Vary: Accept,以避免快取衝突。
頁面動作
頁面動作可讓讀者複製頁面的 Markdown,或在 AI 應用程式中開啟該頁面。這些動作會讀取頁面的 .md 檔案。

從文件頁面的載入器回傳 Markdown URL,再於頁面中算繪這些動作:
import { MarkdownCopyButton, ViewOptionsPopover } from 'fumadocs-ui/layouts/docs/page';
// 在您的載入器中
return {
path: page.path,
markdownUrl: `${page.url}.md`,
};
// 在您的頁面中
<div className="flex flex-row gap-2 items-center border-b pt-2 pb-6">
<MarkdownCopyButton markdownUrl={markdownUrl} />
<ViewOptionsPopover
markdownUrl={markdownUrl}
githubUrl={`https://github.com/${owner}/${repo}/blob/main/content/docs/${encodeURI(path)}`}
/>
</div>;MCP 伺服器
透過 MCP 伺服器將您的文件開放給 AI 代理使用,並提供可列出、搜尋及讀取頁面的工具。
npx @fumadocs/cli feature mcp它會在上述 LLM 路由的基礎上,建立一個使用 streamable HTTP 傳輸層的 /api/mcp 路由。
這些工具來自 fumadocs-core/mcp。
import { createFileRoute } from '@tanstack/react-router';
import { createMcpHandler, McpServer } from '@modelcontextprotocol/server';
import { registerSearchTool, registerSourceTools } from 'fumadocs-core/mcp';
import { createFromSource } from 'fumadocs-core/search/server';
import { docsLlms, source } from '@/lib/source';
const handler = createMcpHandler(() => {
const mcp = new McpServer(
{
name: 'docs',
version: '1.0.0',
},
// the tools never change, a stream to watch them would hold a serverless function open
{ capabilities: { tools: { listChanged: false } } },
);
registerSourceTools(mcp, source, docsLlms);
registerSearchTool(mcp, createFromSource(source));
return mcp;
});
export const Route = createFileRoute('/api/mcp')({
server: {
handlers: {
GET: async ({ request }) => handler.fetch(request),
POST: async ({ request }) => handler.fetch(request),
DELETE: async ({ request }) => handler.fetch(request),
},
},
});
您可以透過以下方式將 AI 代理連接至此路由:
{
"mcpServers": {
"docs": { "url": "https://your-site.com/api/mcp" }
}
}WebMCP
實驗性功能
WebMCP 是一項仍處於早期階段的網頁標準,目前可在
Chrome 149+ 中透過 #enable-webmcp-testing 旗標及來源試用 (origin trial) 使用。其 API 仍可能
變動。
上述 MCP 伺服器服務的是連線至您網站的 AI 代理,而 WebMCP 則是在讀者目前瀏覽的頁面上,將工具提供給瀏覽器的 AI 代理。
npx @fumadocs/cli feature webmcp這會以 LLM 路由為基礎建立一個 WebMCP 元件。請將它算繪在 <RootProvider /> 內。
search_docs會查詢搜尋 API 路由。您可以將fetchClient替換為其他用戶端。read_page會從/docs/page.md擷取頁面的 Markdown 內容。
詢問 AI

您可以使用 Fumadocs CLI 安裝 AI 聊天對話方塊。
npx @fumadocs/cli add ai/openrouter它已透過 Vercel AI SDK 自動完成 OpenRouter 的設定,並為 AI 提供 /search 工具。
若要使用其他模型,請修改 /api/chat 路由。
Fumadocs 不提供 AI 模型,請自行選擇。
您的 AI 模型可以使用上方產生的 llms-full.txt 檔案;若搭配第三方解決方案,也能使用更多元的資訊來源。
文件版面配置會依據其 aiChat 選項算繪聊天介面。此選項需要用戶端狀態,因此請為您的版面配置建立一個用戶端元件,並以它取代原本的版面配置:
'use client';
// 或使用 Notebook、Glass、Spacious 版面配置
import { DocsLayout as Layout, type DocsLayoutProps } from 'fumadocs-ui/layouts/docs';
// 已安裝的元件
import { AIChat, AIChatPanel, useAIChat } from './search';
export function DocsLayout(props: DocsLayoutProps) {
return (
<AIChat>
<ChatLayout {...props} />
</AIChat>
);
}
function ChatLayout(props: DocsLayoutProps) {
const { open, setOpen } = useAIChat();
return (
<Layout
{...props}
aiChat={{ open, onOpenChange: setOpen, panel: <AIChatPanel />, trigger: true }}
/>
);
}How is this guide?
