@vercel/geistdocs 1.3.0-canary.88e35b7 → 1.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/assets/icons/icon-arrow-up-right-small.d.ts +8 -0
- package/dist/assets/icons/icon-arrow-up-right-small.d.ts.map +1 -0
- package/dist/assets/icons/icon-arrow-up-right-small.js +4 -0
- package/dist/assets/icons/icon-arrow-up-right.d.ts +5 -0
- package/dist/assets/icons/icon-arrow-up-right.d.ts.map +1 -0
- package/dist/assets/icons/icon-arrow-up-right.js +4 -0
- package/dist/assets/icons/icon-check.d.ts +5 -0
- package/dist/assets/icons/icon-check.d.ts.map +1 -0
- package/dist/assets/icons/icon-check.js +4 -0
- package/dist/assets/icons/icon-chevron-down-small.d.ts +8 -0
- package/dist/assets/icons/icon-chevron-down-small.d.ts.map +1 -0
- package/dist/assets/icons/icon-chevron-down-small.js +7 -0
- package/dist/assets/icons/icon-chevron-right.d.ts +5 -0
- package/dist/assets/icons/icon-chevron-right.d.ts.map +1 -0
- package/dist/assets/icons/icon-chevron-right.js +4 -0
- package/dist/assets/icons/icon-copy.d.ts +5 -0
- package/dist/assets/icons/icon-copy.d.ts.map +1 -0
- package/dist/assets/icons/icon-copy.js +4 -0
- package/dist/assets/icons/icon-file-text.d.ts +5 -0
- package/dist/assets/icons/icon-file-text.d.ts.map +1 -0
- package/dist/assets/icons/icon-file-text.js +4 -0
- package/dist/assets/icons/icon-menu-alt.d.ts +5 -0
- package/dist/assets/icons/icon-menu-alt.d.ts.map +1 -0
- package/dist/assets/icons/icon-menu-alt.js +4 -0
- package/dist/assets/icons/icon-slash-forward.d.ts +8 -0
- package/dist/assets/icons/icon-slash-forward.d.ts.map +1 -0
- package/dist/assets/icons/icon-slash-forward.js +4 -0
- package/dist/assets/icons/index.d.ts +10 -0
- package/dist/assets/icons/index.d.ts.map +1 -0
- package/{template/components/geistcn-fallbacks/geistcn-assets/icons/index.tsx → dist/assets/icons/index.js} +0 -1
- package/dist/assets/logos/index.d.ts +15 -0
- package/dist/assets/logos/index.d.ts.map +1 -0
- package/{template/components/geistcn-fallbacks/geistcn-assets/logos/index.tsx → dist/assets/logos/index.js} +2 -1
- package/dist/assets/logos/logo-ai-elements.d.ts +8 -0
- package/dist/assets/logos/logo-ai-elements.d.ts.map +1 -0
- package/dist/assets/logos/logo-ai-elements.js +8 -0
- package/dist/assets/logos/logo-ai-sdk.d.ts +8 -0
- package/dist/assets/logos/logo-ai-sdk.d.ts.map +1 -0
- package/dist/assets/logos/logo-ai-sdk.js +8 -0
- package/dist/assets/logos/logo-chat-sdk.d.ts +8 -0
- package/dist/assets/logos/logo-chat-sdk.d.ts.map +1 -0
- package/dist/assets/logos/logo-chat-sdk.js +8 -0
- package/dist/assets/logos/logo-flags-sdk.d.ts +8 -0
- package/dist/assets/logos/logo-flags-sdk.d.ts.map +1 -0
- package/dist/assets/logos/logo-flags-sdk.js +8 -0
- package/dist/assets/logos/logo-icon-vercel.d.ts +9 -0
- package/dist/assets/logos/logo-icon-vercel.d.ts.map +1 -0
- package/dist/assets/logos/logo-icon-vercel.js +8 -0
- package/dist/assets/logos/logo-nextjs.d.ts +8 -0
- package/dist/assets/logos/logo-nextjs.d.ts.map +1 -0
- package/dist/assets/logos/logo-nextjs.js +7 -0
- package/dist/assets/logos/logo-streamdown.d.ts +8 -0
- package/dist/assets/logos/logo-streamdown.d.ts.map +1 -0
- package/dist/assets/logos/logo-streamdown.js +8 -0
- package/dist/assets/logos/logo-svelte-kit.d.ts +5 -0
- package/dist/assets/logos/logo-svelte-kit.d.ts.map +1 -0
- package/dist/assets/logos/logo-svelte-kit.js +4 -0
- package/dist/assets/logos/logo-vercel-oss.d.ts +8 -0
- package/dist/assets/logos/logo-vercel-oss.d.ts.map +1 -0
- package/dist/assets/logos/logo-vercel-oss.js +7 -0
- package/dist/assets/logos/logo-workflow-sdk.d.ts +8 -0
- package/dist/assets/logos/logo-workflow-sdk.d.ts.map +1 -0
- package/dist/assets/logos/logo-workflow-sdk.js +8 -0
- package/dist/cli/index.js +2 -5
- package/dist/components/button-group.d.ts +2 -0
- package/dist/components/button-group.d.ts.map +1 -0
- package/dist/components/button-group.js +2 -0
- package/dist/components/button.d.ts +2 -0
- package/dist/components/button.d.ts.map +1 -0
- package/dist/components/button.js +2 -0
- package/dist/components/card.d.ts +2 -0
- package/dist/components/card.d.ts.map +1 -0
- package/dist/components/card.js +2 -0
- package/dist/components/code-block-tabs.js +3 -3
- package/dist/components/code-block.d.ts.map +1 -1
- package/dist/components/code-block.js +7 -3
- package/dist/components/collapsible.d.ts +2 -0
- package/dist/components/collapsible.d.ts.map +1 -0
- package/dist/components/collapsible.js +3 -0
- package/dist/components/copy-prompt.d.ts +11 -0
- package/dist/components/copy-prompt.d.ts.map +1 -0
- package/dist/components/copy-prompt.js +58 -0
- package/dist/components/dialog.d.ts +13 -0
- package/dist/components/dialog.d.ts.map +1 -0
- package/dist/components/dialog.js +35 -0
- package/dist/components/drawer.d.ts +2 -0
- package/dist/components/drawer.d.ts.map +1 -0
- package/dist/components/drawer.js +3 -0
- package/dist/components/dropdown-menu.d.ts +2 -0
- package/dist/components/dropdown-menu.d.ts.map +1 -0
- package/dist/components/dropdown-menu.js +3 -0
- package/dist/components/input-group.d.ts +2 -0
- package/dist/components/input-group.d.ts.map +1 -0
- package/dist/components/input-group.js +3 -0
- package/dist/components/input.d.ts +2 -0
- package/dist/components/input.d.ts.map +1 -0
- package/dist/components/input.js +2 -0
- package/dist/components/kbd.d.ts +2 -0
- package/dist/components/kbd.d.ts.map +1 -0
- package/dist/components/kbd.js +2 -0
- package/dist/components/navigation-menu.d.ts +2 -0
- package/dist/components/navigation-menu.d.ts.map +1 -0
- package/dist/components/navigation-menu.js +3 -0
- package/dist/components/popover.d.ts +2 -0
- package/dist/components/popover.d.ts.map +1 -0
- package/dist/components/popover.js +3 -0
- package/dist/components/scroll-area.d.ts +2 -0
- package/dist/components/scroll-area.d.ts.map +1 -0
- package/dist/components/scroll-area.js +3 -0
- package/dist/components/separator.d.ts +2 -0
- package/dist/components/separator.d.ts.map +1 -0
- package/dist/components/separator.js +3 -0
- package/dist/components/sheet.d.ts +2 -0
- package/dist/components/sheet.d.ts.map +1 -0
- package/dist/components/sheet.js +3 -0
- package/dist/components/sonner.d.ts +2 -0
- package/dist/components/sonner.d.ts.map +1 -0
- package/dist/components/sonner.js +3 -0
- package/dist/components/spinner.d.ts +2 -0
- package/dist/components/spinner.d.ts.map +1 -0
- package/dist/components/spinner.js +2 -0
- package/dist/components/textarea.d.ts +2 -0
- package/dist/components/textarea.d.ts.map +1 -0
- package/dist/components/textarea.js +2 -0
- package/dist/components/tooltip.d.ts +2 -0
- package/dist/components/tooltip.d.ts.map +1 -0
- package/dist/components/tooltip.js +3 -0
- package/dist/config.d.ts +66 -1
- package/dist/config.d.ts.map +1 -1
- package/dist/controls.js +4 -4
- package/dist/footer.d.ts +8 -0
- package/dist/footer.d.ts.map +1 -0
- package/dist/footer.js +6 -0
- package/dist/home-layout.d.ts +11 -0
- package/dist/home-layout.d.ts.map +1 -0
- package/dist/home-layout.js +31 -0
- package/dist/internal/chat/conversation.js +1 -1
- package/dist/internal/chat/message.js +1 -1
- package/dist/internal/chat/prompt-input.js +1 -1
- package/dist/internal/chat/shell.d.ts.map +1 -1
- package/dist/internal/chat/shell.js +6 -5
- package/dist/internal/chat/sources.js +1 -1
- package/dist/internal/config-context.d.ts +10 -0
- package/dist/internal/config-context.d.ts.map +1 -0
- package/dist/internal/config-context.js +15 -0
- package/dist/internal/footer/github-button.d.ts +7 -0
- package/dist/internal/footer/github-button.d.ts.map +1 -0
- package/dist/internal/footer/github-button.js +10 -0
- package/dist/internal/footer/rss-button.d.ts +2 -0
- package/dist/internal/footer/rss-button.d.ts.map +1 -0
- package/dist/internal/footer/rss-button.js +4 -0
- package/dist/internal/localized-link.d.ts +8 -0
- package/dist/internal/localized-link.d.ts.map +1 -0
- package/dist/internal/localized-link.js +13 -0
- package/dist/internal/navbar/desktop-menu.d.ts +10 -0
- package/dist/internal/navbar/desktop-menu.d.ts.map +1 -0
- package/dist/internal/navbar/desktop-menu.js +11 -0
- package/dist/internal/navbar/mobile-menu.d.ts +7 -0
- package/dist/internal/navbar/mobile-menu.d.ts.map +1 -0
- package/dist/internal/navbar/mobile-menu.js +44 -0
- package/dist/internal/navbar/navbar-logo.d.ts +16 -0
- package/dist/internal/navbar/navbar-logo.d.ts.map +1 -0
- package/dist/internal/navbar/navbar-logo.js +30 -0
- package/dist/internal/page-actions-client.d.ts +1 -2
- package/dist/internal/page-actions-client.d.ts.map +1 -1
- package/dist/internal/page-actions-client.js +28 -11
- package/dist/internal/page-visibility.d.ts +18 -0
- package/dist/internal/page-visibility.d.ts.map +1 -0
- package/dist/internal/page-visibility.js +24 -0
- package/dist/internal/provider-client.d.ts +9 -0
- package/dist/internal/provider-client.d.ts.map +1 -0
- package/dist/internal/provider-client.js +24 -0
- package/dist/internal/sidebar.d.ts +4 -1
- package/dist/internal/sidebar.d.ts.map +1 -1
- package/dist/internal/sidebar.js +8 -7
- package/dist/internal/table-of-contents.d.ts +9 -0
- package/dist/internal/table-of-contents.d.ts.map +1 -0
- package/dist/internal/table-of-contents.js +5 -0
- package/dist/internal/ui/button-group.js +2 -2
- package/dist/internal/ui/button.d.ts +1 -1
- package/dist/internal/ui/button.d.ts.map +1 -1
- package/dist/internal/ui/button.js +7 -7
- package/dist/internal/ui/card.js +1 -1
- package/dist/internal/ui/drawer.js +1 -1
- package/dist/internal/ui/dropdown-menu.js +7 -7
- package/dist/internal/ui/input-group.js +2 -2
- package/dist/internal/ui/input.js +1 -1
- package/dist/internal/ui/kbd.js +1 -1
- package/dist/internal/ui/navigation-menu.d.ts +17 -0
- package/dist/internal/ui/navigation-menu.d.ts.map +1 -0
- package/dist/internal/ui/navigation-menu.js +38 -0
- package/dist/internal/ui/popover.js +1 -1
- package/dist/internal/ui/scroll-area.js +2 -2
- package/dist/internal/ui/separator.js +1 -1
- package/dist/internal/ui/sheet.js +4 -4
- package/dist/internal/ui/sonner.js +3 -3
- package/dist/internal/ui/textarea.js +1 -1
- package/dist/internal/ui/tooltip.js +1 -1
- package/dist/layout.d.ts +4 -8
- package/dist/layout.d.ts.map +1 -1
- package/dist/layout.js +26 -44
- package/dist/mdx.d.ts +55 -24
- package/dist/mdx.d.ts.map +1 -1
- package/dist/mdx.js +9 -46
- package/dist/mobile-docs-bar.d.ts +7 -0
- package/dist/mobile-docs-bar.d.ts.map +1 -0
- package/dist/mobile-docs-bar.js +13 -0
- package/dist/navbar.d.ts +7 -0
- package/dist/navbar.d.ts.map +1 -0
- package/dist/navbar.js +10 -0
- package/dist/pages/docs.d.ts +33 -5
- package/dist/pages/docs.d.ts.map +1 -1
- package/dist/pages/docs.js +57 -22
- package/dist/proxy.d.ts +24 -8
- package/dist/proxy.d.ts.map +1 -1
- package/dist/proxy.js +116 -36
- package/dist/routes/agents.d.ts +21 -0
- package/dist/routes/agents.d.ts.map +1 -0
- package/dist/routes/agents.js +201 -0
- package/dist/routes/chat.d.ts +11 -5
- package/dist/routes/chat.d.ts.map +1 -1
- package/dist/routes/chat.js +386 -65
- package/dist/routes/llms.d.ts +29 -10
- package/dist/routes/llms.d.ts.map +1 -1
- package/dist/routes/llms.js +80 -9
- package/dist/routes/search.d.ts +8 -5
- package/dist/routes/search.d.ts.map +1 -1
- package/dist/routes/search.js +52 -4
- package/dist/routes/sitemap.d.ts +15 -3
- package/dist/routes/sitemap.d.ts.map +1 -1
- package/dist/routes/sitemap.js +32 -6
- package/dist/shiki-theme.d.ts +20 -0
- package/dist/shiki-theme.d.ts.map +1 -0
- package/dist/shiki-theme.js +110 -0
- package/dist/sidebar.d.ts +11 -0
- package/dist/sidebar.d.ts.map +1 -0
- package/dist/sidebar.js +16 -0
- package/dist/source-config.d.ts +68 -0
- package/dist/source-config.d.ts.map +1 -0
- package/dist/source-config.js +161 -0
- package/dist/source.d.ts +155 -4
- package/dist/source.d.ts.map +1 -1
- package/dist/source.js +73 -3
- package/dist/versions.d.ts +45 -0
- package/dist/versions.d.ts.map +1 -0
- package/dist/versions.js +79 -0
- package/package.json +142 -9
- package/source-config.js +174 -0
- package/styles.css +465 -102
- package/template/AGENTS.md +95 -0
- package/template/app/[lang]/(home)/components/centered-section.tsx +1 -3
- package/template/app/[lang]/(home)/components/hero.tsx +2 -2
- package/template/app/[lang]/(home)/components/one-two-section.tsx +1 -3
- package/template/app/[lang]/(home)/components/templates.tsx +3 -5
- package/template/app/[lang]/(home)/components/text-grid-section.tsx +1 -1
- package/template/app/[lang]/(home)/layout.tsx +4 -3
- package/template/app/[lang]/(home)/page.tsx +2 -2
- package/template/app/[lang]/agents.md/route.ts +6 -0
- package/template/app/[lang]/docs/[[...slug]]/page.tsx +4 -1
- package/template/app/[lang]/layout.tsx +6 -6
- package/template/app/[lang]/llms.mdx/[[...slug]]/route.ts +1 -1
- package/template/app/[lang]/llms.txt/route.ts +1 -1
- package/template/app/[lang]/sitemap.md/route.ts +2 -2
- package/template/app/api/chat/route.ts +12 -1
- package/template/app/api/search/route.ts +2 -2
- package/template/app/styles/geistdocs.css +151 -109
- package/template/components/ui/badge.tsx +5 -5
- package/template/components/ui/button.tsx +7 -7
- package/template/components/ui/command-prompt.tsx +2 -2
- package/template/content/docs/agent-readiness.mdx +103 -0
- package/template/content/docs/ask-ai.mdx +61 -5
- package/template/content/docs/configuration.cn.mdx +47 -7
- package/template/content/docs/configuration.mdx +226 -66
- package/template/content/docs/deployment.mdx +17 -0
- package/template/content/docs/edit-on-github.mdx +6 -2
- package/template/content/docs/env.mdx +38 -3
- package/template/content/docs/feedback.mdx +6 -2
- package/template/content/docs/getting-started.cn.mdx +2 -2
- package/template/content/docs/getting-started.mdx +71 -43
- package/template/content/docs/index.cn.mdx +36 -33
- package/template/content/docs/index.mdx +69 -59
- package/template/content/docs/internationalization.cn.mdx +7 -9
- package/template/content/docs/internationalization.mdx +10 -5
- package/template/content/docs/llms-txt.cn.mdx +24 -2
- package/template/content/docs/llms-txt.mdx +48 -12
- package/template/content/docs/md.cn.mdx +12 -15
- package/template/content/docs/md.mdx +30 -16
- package/template/content/docs/meta.json +6 -2
- package/template/content/docs/migration.mdx +364 -0
- package/template/content/docs/open-in-chat.mdx +12 -10
- package/template/content/docs/provider.cn.mdx +6 -5
- package/template/content/docs/provider.mdx +13 -8
- package/template/content/docs/proxy.cn.mdx +96 -0
- package/template/content/docs/proxy.mdx +178 -0
- package/template/content/docs/rss.mdx +6 -2
- package/template/content/docs/syntax.cn.mdx +2 -2
- package/template/content/docs/syntax.mdx +6 -2
- package/template/content/docs/theme-aware-image.mdx +5 -1
- package/template/content/docs/versioned-docs.cn.mdx +117 -0
- package/template/content/docs/versioned-docs.mdx +228 -0
- package/template/geistdocs.tsx +26 -0
- package/template/lib/geistdocs/config.tsx +3 -0
- package/template/package.json +5 -5
- package/template/proxy.ts +2 -1
- package/template/source.config.ts +8 -47
- package/template/app/actions/feedback/emotions.ts +0 -18
- package/template/app/actions/feedback/index.ts +0 -45
- package/template/components/geistcn-fallbacks/geistcn-assets/icons/icon-arrow-up-right-small.tsx +0 -35
- package/template/components/geistcn-fallbacks/geistcn-assets/icons/icon-arrow-up-right.tsx +0 -27
- package/template/components/geistcn-fallbacks/geistcn-assets/icons/icon-check.tsx +0 -27
- package/template/components/geistcn-fallbacks/geistcn-assets/icons/icon-chevron-down-small.tsx +0 -30
- package/template/components/geistcn-fallbacks/geistcn-assets/icons/icon-chevron-right.tsx +0 -27
- package/template/components/geistcn-fallbacks/geistcn-assets/icons/icon-copy.tsx +0 -27
- package/template/components/geistcn-fallbacks/geistcn-assets/icons/icon-file-text.tsx +0 -25
- package/template/components/geistcn-fallbacks/geistcn-assets/icons/icon-menu-alt.tsx +0 -27
- package/template/components/geistcn-fallbacks/geistcn-assets/icons/icon-slash-forward.tsx +0 -36
- package/template/components/geistcn-fallbacks/geistcn-assets/logos/logo-ai-elements.tsx +0 -29
- package/template/components/geistcn-fallbacks/geistcn-assets/logos/logo-ai-sdk.tsx +0 -38
- package/template/components/geistcn-fallbacks/geistcn-assets/logos/logo-chat-sdk.tsx +0 -42
- package/template/components/geistcn-fallbacks/geistcn-assets/logos/logo-flags-sdk.tsx +0 -42
- package/template/components/geistcn-fallbacks/geistcn-assets/logos/logo-icon-vercel.tsx +0 -31
- package/template/components/geistcn-fallbacks/geistcn-assets/logos/logo-streamdown.tsx +0 -29
- package/template/components/geistcn-fallbacks/geistcn-assets/logos/logo-vercel-oss.tsx +0 -24
- package/template/components/geistcn-fallbacks/geistcn-assets/logos/logo-workflow-sdk.tsx +0 -73
- package/template/components/geistdocs/callout.tsx +0 -40
- package/template/components/geistdocs/chat.tsx +0 -24
- package/template/components/geistdocs/code-block-tabs.tsx +0 -61
- package/template/components/geistdocs/code-block.tsx +0 -134
- package/template/components/geistdocs/copy-page.tsx +0 -27
- package/template/components/geistdocs/desktop-menu.tsx +0 -52
- package/template/components/geistdocs/docs-page.tsx +0 -35
- package/template/components/geistdocs/edit-source.tsx +0 -30
- package/template/components/geistdocs/feedback.tsx +0 -139
- package/template/components/geistdocs/footer.tsx +0 -30
- package/template/components/geistdocs/github-button.tsx +0 -19
- package/template/components/geistdocs/home-layout.tsx +0 -46
- package/template/components/geistdocs/icons.tsx +0 -13
- package/template/components/geistdocs/installer.tsx +0 -58
- package/template/components/geistdocs/language-selector.tsx +0 -3
- package/template/components/geistdocs/mermaid.tsx +0 -68
- package/template/components/geistdocs/mobile-docs-bar.tsx +0 -81
- package/template/components/geistdocs/mobile-menu.tsx +0 -150
- package/template/components/geistdocs/navbar-logo.tsx +0 -124
- package/template/components/geistdocs/navbar.tsx +0 -22
- package/template/components/geistdocs/rss-button.tsx +0 -10
- package/template/components/geistdocs/scroll-top.tsx +0 -21
- package/template/components/geistdocs/search.tsx +0 -17
- package/template/components/geistdocs/sidebar.tsx +0 -128
- package/template/components/geistdocs/theme-aware-image.tsx +0 -22
- package/template/components/geistdocs/theme-toggle.tsx +0 -3
- package/template/components/geistdocs/video.tsx +0 -16
- package/template/components/ui/button-group.tsx +0 -83
- package/template/components/ui/card.tsx +0 -92
- package/template/components/ui/collapsible.tsx +0 -33
- package/template/components/ui/command.tsx +0 -184
- package/template/components/ui/dialog.tsx +0 -143
- package/template/components/ui/drawer.tsx +0 -135
- package/template/components/ui/dropdown-menu.tsx +0 -257
- package/template/components/ui/hover-card.tsx +0 -44
- package/template/components/ui/input-group.tsx +0 -170
- package/template/components/ui/input.tsx +0 -21
- package/template/components/ui/kbd.tsx +0 -28
- package/template/components/ui/navigation-menu.tsx +0 -192
- package/template/components/ui/popover.tsx +0 -48
- package/template/components/ui/scroll-area.tsx +0 -58
- package/template/components/ui/select.tsx +0 -187
- package/template/components/ui/separator.tsx +0 -28
- package/template/components/ui/sheet.tsx +0 -139
- package/template/components/ui/sonner.tsx +0 -40
- package/template/components/ui/spinner.tsx +0 -16
- package/template/components/ui/textarea.tsx +0 -18
- package/template/components/ui/tooltip.tsx +0 -61
- package/template/hooks/geistdocs/use-sidebar.ts +0 -13
- package/template/hooks/use-mobile.ts +0 -19
|
@@ -5,9 +5,10 @@ type: conceptual
|
|
|
5
5
|
summary: 通过在 URL 后追加 .md 或 .mdx 以原始 Markdown 格式访问任何文档页面,供 AI 工具使用。
|
|
6
6
|
related:
|
|
7
7
|
- /docs/llms-txt
|
|
8
|
+
- /docs/proxy
|
|
8
9
|
---
|
|
9
10
|
|
|
10
|
-
Geistdocs
|
|
11
|
+
Geistdocs 允许 AI 工具和语言模型以纯 Markdown 的形式访问文档页面。在文档 URL 后追加 `.md` 或 `.mdx`,即可获取该页面处理后的 Markdown 内容。
|
|
11
12
|
|
|
12
13
|
## 工作原理
|
|
13
14
|
|
|
@@ -40,22 +41,18 @@ https://yourdomain.com/docs/getting-started.mdx
|
|
|
40
41
|
|
|
41
42
|
## 实现
|
|
42
43
|
|
|
43
|
-
|
|
44
|
+
包内 proxy 会将 `.md` 和 `.mdx` 请求路由到返回 Markdown 的 route handler:
|
|
44
45
|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
destination: "/llms.mdx/:path*",
|
|
53
|
-
},
|
|
54
|
-
];
|
|
55
|
-
}
|
|
46
|
+
```ts title="proxy.ts"
|
|
47
|
+
const proxy = createProxy({
|
|
48
|
+
config: geistdocsConfig,
|
|
49
|
+
markdownRoutes: [
|
|
50
|
+
{ from: "/docs/*path", to: "/[lang]/llms.mdx/*path" },
|
|
51
|
+
],
|
|
52
|
+
});
|
|
56
53
|
```
|
|
57
54
|
|
|
58
|
-
|
|
55
|
+
目标 route 使用 `createDocsMarkdownRoute` 处理页面,并以 `text/markdown` 内容类型返回 Markdown。
|
|
59
56
|
|
|
60
57
|
## 响应格式
|
|
61
58
|
|
|
@@ -65,4 +62,4 @@ async rewrites() {
|
|
|
65
62
|
- 页面标题作为一级标题
|
|
66
63
|
- 来自 Fumadocs 的处理后 Markdown 内容
|
|
67
64
|
|
|
68
|
-
所有 MDX 组件都会被处理并转换为等效的纯 Markdown。
|
|
65
|
+
所有 MDX 组件都会被处理并转换为等效的纯 Markdown。
|
|
@@ -4,14 +4,20 @@ description: Access documentation pages as raw Markdown by appending .md or .mdx
|
|
|
4
4
|
type: conceptual
|
|
5
5
|
summary: Access any documentation page as raw Markdown by appending .md or .mdx to the URL for AI tool consumption.
|
|
6
6
|
related:
|
|
7
|
+
- /docs/agent-readiness
|
|
7
8
|
- /docs/llms-txt
|
|
9
|
+
- /docs/proxy
|
|
8
10
|
---
|
|
9
11
|
|
|
10
|
-
Geistdocs
|
|
12
|
+
Geistdocs lets AI tools and language models access documentation pages as plain Markdown. Append `.md` or `.mdx` to a documentation URL to get the processed Markdown content for that page.
|
|
11
13
|
|
|
12
|
-
|
|
14
|
+
<CopyPrompt text="Help me test raw Markdown routes in this Geistdocs project. Fetch a docs page with .mdx appended, compare it to the rendered page, and explain how AI tools can use it.">
|
|
15
|
+
Help me test raw Markdown routes in this Geistdocs project. Fetch a docs page with `.mdx` appended, compare it to the rendered page, and explain how AI tools can use it.
|
|
16
|
+
</CopyPrompt>
|
|
13
17
|
|
|
14
|
-
|
|
18
|
+
## How it works
|
|
19
|
+
|
|
20
|
+
When you add `.md` or `.mdx` to a documentation URL, Geistdocs returns the page content as Markdown instead of rendered HTML. AI tools can use that response as focused context for one page.
|
|
15
21
|
|
|
16
22
|
### Example
|
|
17
23
|
|
|
@@ -29,7 +35,7 @@ The `.mdx` version returns:
|
|
|
29
35
|
- The full processed Markdown content
|
|
30
36
|
- No HTML, styling, or navigation
|
|
31
37
|
|
|
32
|
-
## Use
|
|
38
|
+
## Use cases
|
|
33
39
|
|
|
34
40
|
This feature is particularly useful for:
|
|
35
41
|
|
|
@@ -40,22 +46,30 @@ This feature is particularly useful for:
|
|
|
40
46
|
|
|
41
47
|
## Implementation
|
|
42
48
|
|
|
43
|
-
The
|
|
49
|
+
The package proxy routes `.md` and `.mdx` requests to the package-backed markdown route handler:
|
|
50
|
+
|
|
51
|
+
```ts title="proxy.ts"
|
|
52
|
+
const proxy = createProxy({
|
|
53
|
+
config: geistdocsConfig,
|
|
54
|
+
markdownRoutes: [
|
|
55
|
+
{ from: "/docs/*path", to: "/[lang]/llms.mdx/*path" },
|
|
56
|
+
],
|
|
57
|
+
});
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
The destination route uses `createDocsMarkdownRoute` to process the page and return Markdown with a `text/markdown` content type:
|
|
44
61
|
|
|
45
|
-
|
|
62
|
+
```ts title="app/[lang]/llms.mdx/[[...slug]]/route.ts"
|
|
63
|
+
import { createDocsMarkdownRoute } from "@vercel/geistdocs/routes/llms";
|
|
64
|
+
import { geistdocsSource } from "@/lib/geistdocs/source";
|
|
46
65
|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
source: "/docs/:path*.mdx",
|
|
52
|
-
destination: "/llms.mdx/:path*",
|
|
53
|
-
},
|
|
54
|
-
];
|
|
55
|
-
}
|
|
66
|
+
export const { GET, generateStaticParams, revalidate } =
|
|
67
|
+
createDocsMarkdownRoute({
|
|
68
|
+
sources: [geistdocsSource],
|
|
69
|
+
});
|
|
56
70
|
```
|
|
57
71
|
|
|
58
|
-
|
|
72
|
+
Read [Proxy and markdown routes](/docs/proxy) to configure additional route families such as `/cookbook` or `/v5/docs`.
|
|
59
73
|
|
|
60
74
|
## Response Format
|
|
61
75
|
|
|
@@ -1,20 +1,24 @@
|
|
|
1
1
|
{
|
|
2
|
-
"title": "
|
|
3
|
-
"description": "
|
|
2
|
+
"title": "Geistdocs Documentation",
|
|
3
|
+
"description": "Learn how to use and customize Geistdocs",
|
|
4
4
|
"root": true,
|
|
5
5
|
"pages": [
|
|
6
6
|
"index",
|
|
7
7
|
"getting-started",
|
|
8
8
|
"env",
|
|
9
9
|
"deployment",
|
|
10
|
+
"migration",
|
|
10
11
|
"configuration",
|
|
11
12
|
"---Internals---",
|
|
12
13
|
"syntax",
|
|
13
14
|
"provider",
|
|
15
|
+
"versioned-docs",
|
|
16
|
+
"proxy",
|
|
14
17
|
"---Features---",
|
|
15
18
|
"...",
|
|
16
19
|
"---AI---",
|
|
17
20
|
"open-in-chat",
|
|
21
|
+
"agent-readiness",
|
|
18
22
|
"llms-txt",
|
|
19
23
|
"ask-ai"
|
|
20
24
|
]
|
|
@@ -0,0 +1,364 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Migration guide
|
|
3
|
+
description: Migrate a Fumadocs or custom Geist docs site to package-backed Geistdocs
|
|
4
|
+
type: guide
|
|
5
|
+
summary: Move an existing documentation site to @vercel/geistdocs while keeping local content, routing, middleware behavior, and AI-readable surfaces intact.
|
|
6
|
+
prerequisites:
|
|
7
|
+
- /docs/configuration
|
|
8
|
+
- /docs/proxy
|
|
9
|
+
related:
|
|
10
|
+
- /docs/versioned-docs
|
|
11
|
+
- /docs/llms-txt
|
|
12
|
+
- /docs/agent-readiness
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
Migrate an existing Fumadocs or custom Geist documentation site to `@vercel/geistdocs` by moving shared behavior into package APIs and keeping site-specific adapters local. The safest migration keeps content, routing decisions, and product-specific UI in your app while replacing copied runtime code with thin package-backed adapters.
|
|
16
|
+
|
|
17
|
+
<CopyPrompt text="Help me migrate this existing docs site to package-backed Geistdocs. Inspect source.config.ts, lib/geistdocs/source.ts, app route files, proxy.ts or middleware.ts, public/llms.txt, Open Graph routes, Tailwind CSS setup, package.json AI SDK dependencies, and environment variables. Then produce a step-by-step migration plan using @vercel/geistdocs package APIs without copying package internals.">
|
|
18
|
+
Help me migrate this existing docs site to package-backed Geistdocs. Inspect `source.config.ts`, `lib/geistdocs/source.ts`, app route files, `proxy.ts` or `middleware.ts`, `public/llms.txt`, Open Graph routes, Tailwind CSS setup, `package.json` AI SDK dependencies, and environment variables. Then produce a step-by-step migration plan using `@vercel/geistdocs` package APIs without copying package internals.
|
|
19
|
+
</CopyPrompt>
|
|
20
|
+
|
|
21
|
+
## Before you migrate
|
|
22
|
+
|
|
23
|
+
Create a working branch and inventory the current site before replacing code:
|
|
24
|
+
|
|
25
|
+
- Existing Fumadocs collections in `source.config.ts`.
|
|
26
|
+
- Public route families, such as `/docs`, `/api-reference`, `/guides`, or `/`.
|
|
27
|
+
- Existing `middleware.ts` or `proxy.ts` behavior.
|
|
28
|
+
- Static files that overlap package routes, such as `public/llms.txt`.
|
|
29
|
+
- Search, chat, `llms.txt`, page-level Markdown, `sitemap.md`, `agents.md`, RSS, and Open Graph routes.
|
|
30
|
+
- Tailwind CSS version and custom plugins.
|
|
31
|
+
- Direct app usage of `ai` or `@ai-sdk/react` outside Geistdocs.
|
|
32
|
+
- Environment variables required by the homepage, docs routes, or API routes.
|
|
33
|
+
|
|
34
|
+
Run the current project before changing it:
|
|
35
|
+
|
|
36
|
+
```bash title="Terminal"
|
|
37
|
+
pnpm install
|
|
38
|
+
pnpm build
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Fix unrelated build failures first. A migration is safer when the starting point is reproducible.
|
|
42
|
+
|
|
43
|
+
## Install Geistdocs
|
|
44
|
+
|
|
45
|
+
Add `@vercel/geistdocs` and align the supported Fumadocs and Next.js dependencies for the package version you are adopting.
|
|
46
|
+
|
|
47
|
+
For an existing project, use your package manager directly:
|
|
48
|
+
|
|
49
|
+
```bash title="Terminal"
|
|
50
|
+
pnpm add @vercel/geistdocs
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
If you are starting from a generated Geistdocs project and moving content into it, use the CLI:
|
|
54
|
+
|
|
55
|
+
```bash title="Terminal"
|
|
56
|
+
pnpm dlx @vercel/geistdocs init --name my-docs
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## Align Ask AI dependencies
|
|
60
|
+
|
|
61
|
+
Geistdocs Ask AI uses AI SDK v6. Generated projects install `ai` v6 and `@ai-sdk/react` v3 so package-owned chat components and route helpers use the supported AI SDK APIs.
|
|
62
|
+
|
|
63
|
+
If the existing app imports `ai` or `@ai-sdk/react` for product-specific features, migrate that code separately. Keep Geistdocs route adapters package-backed, and do not copy package chat internals into the app to preserve older AI SDK behavior.
|
|
64
|
+
|
|
65
|
+
## Update source config
|
|
66
|
+
|
|
67
|
+
Use the source-config-safe export from `@vercel/geistdocs/source-config` in `source.config.ts`. This file is evaluated by `fumadocs-mdx` during dependency installation and builds, so avoid importing runtime component entry points from it.
|
|
68
|
+
|
|
69
|
+
```ts title="source.config.ts"
|
|
70
|
+
import {
|
|
71
|
+
defineGeistdocsSourceConfig,
|
|
72
|
+
geistdocsFrontmatterSchema,
|
|
73
|
+
geistdocsMetaSchema,
|
|
74
|
+
} from "@vercel/geistdocs/source-config";
|
|
75
|
+
import { defineDocs } from "fumadocs-mdx/config";
|
|
76
|
+
|
|
77
|
+
export const docs = defineDocs({
|
|
78
|
+
dir: "content/docs",
|
|
79
|
+
docs: {
|
|
80
|
+
schema: geistdocsFrontmatterSchema,
|
|
81
|
+
postprocess: {
|
|
82
|
+
includeProcessedMarkdown: true,
|
|
83
|
+
},
|
|
84
|
+
},
|
|
85
|
+
meta: {
|
|
86
|
+
schema: geistdocsMetaSchema,
|
|
87
|
+
},
|
|
88
|
+
});
|
|
89
|
+
|
|
90
|
+
export default defineGeistdocsSourceConfig();
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
For multiple docs families, create one collection per directory and reuse `geistdocsFrontmatterSchema`.
|
|
94
|
+
|
|
95
|
+
## Create the package config
|
|
96
|
+
|
|
97
|
+
Use `@vercel/geistdocs/config` to centralize site metadata and route families in `lib/geistdocs/config.tsx`.
|
|
98
|
+
|
|
99
|
+
```tsx title="lib/geistdocs/config.tsx"
|
|
100
|
+
import { defineConfig } from "@vercel/geistdocs/config";
|
|
101
|
+
import { Logo, github, nav, prompt, suggestions, title } from "@/geistdocs";
|
|
102
|
+
|
|
103
|
+
export const config = defineConfig({
|
|
104
|
+
title,
|
|
105
|
+
defaultLanguage: "en",
|
|
106
|
+
logo: <Logo />,
|
|
107
|
+
github,
|
|
108
|
+
nav,
|
|
109
|
+
content: [{ id: "docs", label: "Docs", dir: "content/docs", route: "/docs" }],
|
|
110
|
+
ai: {
|
|
111
|
+
prompt,
|
|
112
|
+
suggestions,
|
|
113
|
+
},
|
|
114
|
+
});
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
Set `content` to every public documentation route family. `createProxy` uses this metadata to infer standard Markdown mappings for non-root sections.
|
|
118
|
+
|
|
119
|
+
## Connect Fumadocs sources
|
|
120
|
+
|
|
121
|
+
Wrap each Fumadocs collection with `createSource` in `lib/geistdocs/source.ts`.
|
|
122
|
+
|
|
123
|
+
```ts title="lib/geistdocs/source.ts"
|
|
124
|
+
import { createSource } from "@vercel/geistdocs/source";
|
|
125
|
+
import { docs } from "@/.source/server";
|
|
126
|
+
import { config } from "./config";
|
|
127
|
+
|
|
128
|
+
export const geistdocsSource = createSource({
|
|
129
|
+
docs,
|
|
130
|
+
config,
|
|
131
|
+
id: "docs",
|
|
132
|
+
label: "Docs",
|
|
133
|
+
});
|
|
134
|
+
|
|
135
|
+
export const source = geistdocsSource.source;
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
For root-mounted docs, set `baseUrl: "/"` and use explicit `markdownRoutes` in `proxy.ts`:
|
|
139
|
+
|
|
140
|
+
```ts title="lib/geistdocs/source.ts"
|
|
141
|
+
export const geistdocsSource = createSource({
|
|
142
|
+
docs,
|
|
143
|
+
config,
|
|
144
|
+
baseUrl: "/",
|
|
145
|
+
});
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
## Add route adapters
|
|
149
|
+
|
|
150
|
+
Keep App Router files thin. Route files should call package helpers instead of copying package internals.
|
|
151
|
+
|
|
152
|
+
```tsx title="app/[lang]/docs/[[...slug]]/page.tsx"
|
|
153
|
+
import { createDocsPage } from "@vercel/geistdocs/pages/docs";
|
|
154
|
+
import { config } from "@/lib/geistdocs/config";
|
|
155
|
+
import { geistdocsSource } from "@/lib/geistdocs/source";
|
|
156
|
+
|
|
157
|
+
const docsPage = createDocsPage({
|
|
158
|
+
config,
|
|
159
|
+
source: geistdocsSource,
|
|
160
|
+
openGraph: {
|
|
161
|
+
images: true,
|
|
162
|
+
},
|
|
163
|
+
});
|
|
164
|
+
|
|
165
|
+
export default docsPage.Page;
|
|
166
|
+
export const generateStaticParams = docsPage.generateStaticParams;
|
|
167
|
+
export const generateMetadata = docsPage.generateMetadata;
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
Set `openGraph.images` to `true` only when your app includes the Geistdocs OG route. If you do not add the OG route, omit `openGraph` or override metadata to avoid broken `/og/...` references.
|
|
171
|
+
|
|
172
|
+
## Add AI-readable routes
|
|
173
|
+
|
|
174
|
+
Add the package route helpers for machine-readable docs surfaces.
|
|
175
|
+
|
|
176
|
+
```ts title="app/[lang]/llms.txt/route.ts"
|
|
177
|
+
import { createLlmsRoute } from "@vercel/geistdocs/routes/llms";
|
|
178
|
+
import { geistdocsSource } from "@/lib/geistdocs/source";
|
|
179
|
+
|
|
180
|
+
export const { GET, revalidate } = createLlmsRoute({
|
|
181
|
+
sources: [geistdocsSource],
|
|
182
|
+
});
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
```ts title="app/[lang]/llms.mdx/[[...slug]]/route.ts"
|
|
186
|
+
import { createDocsMarkdownRoute } from "@vercel/geistdocs/routes/llms";
|
|
187
|
+
import { geistdocsSource } from "@/lib/geistdocs/source";
|
|
188
|
+
|
|
189
|
+
export const { GET, generateStaticParams, revalidate } =
|
|
190
|
+
createDocsMarkdownRoute({
|
|
191
|
+
source: geistdocsSource,
|
|
192
|
+
});
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
```ts title="app/[lang]/sitemap.md/route.ts"
|
|
196
|
+
import { createSitemapMarkdownRoute } from "@vercel/geistdocs/routes/sitemap";
|
|
197
|
+
import { config } from "@/lib/geistdocs/config";
|
|
198
|
+
import { geistdocsSource } from "@/lib/geistdocs/source";
|
|
199
|
+
|
|
200
|
+
export const { GET, generateStaticParams, revalidate, dynamic } =
|
|
201
|
+
createSitemapMarkdownRoute({
|
|
202
|
+
config,
|
|
203
|
+
sources: [{ source: geistdocsSource.source }],
|
|
204
|
+
});
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
```ts title="app/[lang]/agents.md/route.ts"
|
|
208
|
+
import { createAgentsRoute } from "@vercel/geistdocs/routes/agents";
|
|
209
|
+
import { config } from "@/lib/geistdocs/config";
|
|
210
|
+
|
|
211
|
+
export const { GET, generateStaticParams, revalidate } = createAgentsRoute({
|
|
212
|
+
config,
|
|
213
|
+
});
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
Delete `public/llms.txt` after adding `createLlmsRoute`. Static files in `public` can mask App Router route behavior.
|
|
217
|
+
|
|
218
|
+
## Add search and Ask AI routes
|
|
219
|
+
|
|
220
|
+
Use package route helpers for search and chat. Keep these files as adapters so `@vercel/geistdocs` can ship AI SDK compatibility fixes.
|
|
221
|
+
|
|
222
|
+
```ts title="app/api/search/route.ts"
|
|
223
|
+
import { createSearchRoute } from "@vercel/geistdocs/routes/search";
|
|
224
|
+
import { config } from "@/lib/geistdocs/config";
|
|
225
|
+
import { geistdocsSource } from "@/lib/geistdocs/source";
|
|
226
|
+
|
|
227
|
+
export const GET = createSearchRoute({ config, sources: [geistdocsSource] });
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
```ts title="app/api/chat/route.ts"
|
|
231
|
+
import { createChatRoute } from "@vercel/geistdocs/routes/chat";
|
|
232
|
+
import { config } from "@/lib/geistdocs/config";
|
|
233
|
+
import { geistdocsSource } from "@/lib/geistdocs/source";
|
|
234
|
+
|
|
235
|
+
const chatProxyUrl = process.env.GEISTDOCS_CHAT_PROXY_URL;
|
|
236
|
+
const chatProxyToken = process.env.GEISTDOCS_CHAT_PROXY_TOKEN;
|
|
237
|
+
|
|
238
|
+
export const { POST, maxDuration } = createChatRoute({
|
|
239
|
+
config,
|
|
240
|
+
proxy: chatProxyUrl
|
|
241
|
+
? {
|
|
242
|
+
url: chatProxyUrl,
|
|
243
|
+
headers: chatProxyToken
|
|
244
|
+
? { Authorization: `Bearer ${chatProxyToken}` }
|
|
245
|
+
: undefined,
|
|
246
|
+
}
|
|
247
|
+
: undefined,
|
|
248
|
+
sources: [geistdocsSource],
|
|
249
|
+
});
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
Leave `GEISTDOCS_CHAT_PROXY_URL` unset for default AI Gateway mode. Set it to a `/vertex` proxy URL only when Ask AI should route model requests through the central Vertex-backed service.
|
|
253
|
+
|
|
254
|
+
## Migrate middleware behavior
|
|
255
|
+
|
|
256
|
+
Use `createProxy` in `proxy.ts`. Put existing `middleware.ts` behavior in `before` or `after` hooks instead of replacing Geistdocs markdown negotiation.
|
|
257
|
+
|
|
258
|
+
```ts title="proxy.ts"
|
|
259
|
+
import { createProxy } from "@vercel/geistdocs/proxy";
|
|
260
|
+
import { NextResponse } from "next/server";
|
|
261
|
+
import { config as geistdocsConfig } from "@/lib/geistdocs/config";
|
|
262
|
+
|
|
263
|
+
const proxy = createProxy({
|
|
264
|
+
config: geistdocsConfig,
|
|
265
|
+
before: async ({ request }) => {
|
|
266
|
+
if (request.nextUrl.pathname === "/legacy-docs") {
|
|
267
|
+
return NextResponse.redirect(new URL("/docs", request.url));
|
|
268
|
+
}
|
|
269
|
+
|
|
270
|
+
return null;
|
|
271
|
+
},
|
|
272
|
+
});
|
|
273
|
+
|
|
274
|
+
export const config = {
|
|
275
|
+
matcher: [
|
|
276
|
+
"/((?!api(?:/|$)|_next/static|_next/image|favicon.ico|sitemap.xml|robots.txt).*)",
|
|
277
|
+
],
|
|
278
|
+
};
|
|
279
|
+
|
|
280
|
+
export default proxy;
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
Use `api(?:/|$)` in the matcher. A broad `api` exclusion also excludes routes such as `/api-reference`.
|
|
284
|
+
|
|
285
|
+
## Configure Markdown route mappings
|
|
286
|
+
|
|
287
|
+
For standard non-root sections, `createProxy` can infer Markdown routes from `config.content`.
|
|
288
|
+
|
|
289
|
+
Use explicit `markdownRoutes` when the public docs URL does not map directly to the Markdown route handler:
|
|
290
|
+
|
|
291
|
+
```ts title="proxy.ts"
|
|
292
|
+
const proxy = createProxy({
|
|
293
|
+
config: geistdocsConfig,
|
|
294
|
+
markdownRoutes: [
|
|
295
|
+
{ from: "/docs/*path", to: "/[lang]/llms.mdx/*path" },
|
|
296
|
+
{ from: "/api-reference/*path", to: "/[lang]/llms.mdx/api-reference/*path" },
|
|
297
|
+
],
|
|
298
|
+
});
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
Root-mounted docs need explicit mappings. If a homepage or app routes also live at `/`, do not use a broad `/*path` mapping. Map each docs family separately:
|
|
302
|
+
|
|
303
|
+
```ts title="proxy.ts"
|
|
304
|
+
const proxy = createProxy({
|
|
305
|
+
config: geistdocsConfig,
|
|
306
|
+
markdownRoutes: [
|
|
307
|
+
{ from: "/guides/*path", to: "/[lang]/llms.mdx/guides/*path" },
|
|
308
|
+
{ from: "/api-reference/*path", to: "/[lang]/llms.mdx/api-reference/*path" },
|
|
309
|
+
],
|
|
310
|
+
});
|
|
311
|
+
```
|
|
312
|
+
|
|
313
|
+
## Configure Tailwind CSS
|
|
314
|
+
|
|
315
|
+
Tailwind CSS v4 requires `@source` entries for package components and related dependencies.
|
|
316
|
+
|
|
317
|
+
```css title="app/styles/geistdocs.css"
|
|
318
|
+
@import "tailwindcss";
|
|
319
|
+
@import "fumadocs-ui/css/shadcn.css";
|
|
320
|
+
@import "fumadocs-ui/css/preset.css";
|
|
321
|
+
@import "tw-animate-css";
|
|
322
|
+
|
|
323
|
+
@source "../../node_modules/@vercel/geistdocs/dist/**/*.js";
|
|
324
|
+
@source "../../node_modules/streamdown/dist/*.js";
|
|
325
|
+
```
|
|
326
|
+
|
|
327
|
+
Move Tailwind CSS v3 plugin utilities into CSS-first v4 utilities or theme variables. Keep custom token names stable while you migrate components.
|
|
328
|
+
|
|
329
|
+
## Handle environment variables
|
|
330
|
+
|
|
331
|
+
Do not require production secrets for local migration builds. If a homepage or API route depends on a production-only secret, add a local fallback or disable that integration in development.
|
|
332
|
+
|
|
333
|
+
```ts title="lib/example-secret.ts"
|
|
334
|
+
export const flagsSecret =
|
|
335
|
+
process.env.FLAGS_SECRET ??
|
|
336
|
+
(process.env.NODE_ENV === "development" ? "local-development-secret" : undefined);
|
|
337
|
+
```
|
|
338
|
+
|
|
339
|
+
Keep real secrets in `.env.local` and out of Git.
|
|
340
|
+
|
|
341
|
+
## Verify the migration
|
|
342
|
+
|
|
343
|
+
Run the same checks after each routing or source change:
|
|
344
|
+
|
|
345
|
+
```bash title="Terminal"
|
|
346
|
+
pnpm postinstall
|
|
347
|
+
pnpm build
|
|
348
|
+
pnpm dev
|
|
349
|
+
```
|
|
350
|
+
|
|
351
|
+
Check these URLs locally:
|
|
352
|
+
|
|
353
|
+
- `/docs` or the migrated docs root.
|
|
354
|
+
- `/llms.txt`.
|
|
355
|
+
- `/sitemap.md`.
|
|
356
|
+
- `/agents.md`.
|
|
357
|
+
- A page-level Markdown URL such as `/docs/getting-started.mdx`.
|
|
358
|
+
- A non-docs route that should not be rewritten as Markdown, such as the homepage.
|
|
359
|
+
|
|
360
|
+
## Next steps
|
|
361
|
+
|
|
362
|
+
- Read [Configuration](/docs/configuration) to review package config options.
|
|
363
|
+
- Read [Proxy and markdown routes](/docs/proxy) to tune request handling.
|
|
364
|
+
- Read [Agent readiness](/docs/agent-readiness) to configure `/agents.md` for AI agents.
|
|
@@ -10,7 +10,11 @@ related:
|
|
|
10
10
|
|
|
11
11
|
The "Open in Chat" feature enables users to seamlessly transfer documentation context to their preferred AI assistant. With a single click, users can open the current page in external AI chat platforms like ChatGPT, Claude, v0, Cursor, and more.
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
<CopyPrompt text="Help me test Open in Chat for this Geistdocs site. Verify that page URLs resolve correctly, markdown endpoints work, and each configured AI platform receives useful context.">
|
|
14
|
+
Help me test Open in Chat for this Geistdocs site. Verify that page URLs resolve correctly, markdown endpoints work, and each configured AI platform receives useful context.
|
|
15
|
+
</CopyPrompt>
|
|
16
|
+
|
|
17
|
+
## How it works
|
|
14
18
|
|
|
15
19
|
On every documentation page, users will find an "Open in chat" button in the table of contents sidebar. When clicked, a menu appears with options to open the page in various AI platforms:
|
|
16
20
|
|
|
@@ -61,18 +65,16 @@ Each platform has its own integration:
|
|
|
61
65
|
- **Desktop applications** (Cursor): Open using a custom URL scheme that launches the application
|
|
62
66
|
- **Specialized tools** (T3, Scira): Open with platform-specific parameters and context
|
|
63
67
|
|
|
64
|
-
##
|
|
68
|
+
## Outcomes
|
|
65
69
|
|
|
66
70
|
### For Users
|
|
67
71
|
|
|
68
|
-
1. **
|
|
69
|
-
2. **Consistent
|
|
70
|
-
3. **
|
|
71
|
-
4. **Choice of Tools** - Use the AI platform they're most comfortable with
|
|
72
|
+
1. **Context transfer**: Users do not need to manually copy URLs or switch contexts.
|
|
73
|
+
2. **Consistent starting point**: Each AI platform receives the same page context.
|
|
74
|
+
3. **Tool choice**: Users can open the AI platform they prefer.
|
|
72
75
|
|
|
73
76
|
### For Documentation Authors
|
|
74
77
|
|
|
75
|
-
1. **
|
|
76
|
-
2. **
|
|
77
|
-
3. **
|
|
78
|
-
4. **Platform Flexibility** - Support users' diverse AI preferences
|
|
78
|
+
1. **More support paths**: Users can ask follow-up questions about a page.
|
|
79
|
+
2. **Lower support load**: AI assistants can answer common documentation questions.
|
|
80
|
+
3. **Platform flexibility**: Teams can support different AI preferences.
|
|
@@ -9,15 +9,16 @@ related:
|
|
|
9
9
|
- /docs/configuration
|
|
10
10
|
---
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
`GeistdocsProvider` 位于应用根部,负责连接主题、搜索、AI chat、通知和可选分析功能。
|
|
13
13
|
|
|
14
14
|
## 它的作用
|
|
15
15
|
|
|
16
16
|
该提供者为您处理以下主要事项:
|
|
17
17
|
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
18
|
+
1. **Toast 通知**:提供全局通知系统,用于向用户反馈。
|
|
19
|
+
2. **分析**:当本地 adapter 引入 Vercel Analytics 和 Speed Insights 时,将它们连接到站点。
|
|
20
|
+
3. **搜索**:配置搜索对话框并连接到搜索 API。
|
|
21
|
+
4. **Ask AI**:提供 chat 侧边栏和页面操作所需的客户端状态。
|
|
21
22
|
|
|
22
23
|
## 用法
|
|
23
24
|
|
|
@@ -66,4 +67,4 @@ toast.error("Something went wrong");
|
|
|
66
67
|
- 用户交互
|
|
67
68
|
- 性能指标
|
|
68
69
|
|
|
69
|
-
无需配置 —— 部署到 Vercel 后会自动生效。
|
|
70
|
+
无需配置 —— 部署到 Vercel 后会自动生效。
|
|
@@ -9,15 +9,20 @@ related:
|
|
|
9
9
|
- /docs/configuration
|
|
10
10
|
---
|
|
11
11
|
|
|
12
|
-
The `GeistdocsProvider`
|
|
12
|
+
The `GeistdocsProvider` wraps the root of your application with package-managed UI state. It connects theme, search, AI chat, notifications, and optional analytics to the rest of your Geistdocs site.
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
<CopyPrompt text="Review my Geistdocs provider setup. Check that the root layout wraps the app with GeistdocsProvider, that config is passed correctly, and that analytics, search, theme, and Ask AI behavior are wired safely.">
|
|
15
|
+
Review my Geistdocs provider setup. Check that the root layout wraps the app with `GeistdocsProvider`, that config is passed correctly, and that analytics, search, theme, and Ask AI behavior are wired safely.
|
|
16
|
+
</CopyPrompt>
|
|
15
17
|
|
|
16
|
-
|
|
18
|
+
## What it does
|
|
17
19
|
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
20
|
+
The provider handles these behaviors:
|
|
21
|
+
|
|
22
|
+
1. **Toast notifications**: Provides a global notification system for user feedback.
|
|
23
|
+
2. **Analytics**: Integrates Vercel Analytics and Speed Insights when the local adapter includes them.
|
|
24
|
+
3. **Search**: Configures the search dialog and connects it to your search API.
|
|
25
|
+
4. **Ask AI**: Provides the client state used by the chat sidebar and page actions.
|
|
21
26
|
|
|
22
27
|
## Usage
|
|
23
28
|
|
|
@@ -38,13 +43,13 @@ const Layout = ({ children }: LayoutProps) => (
|
|
|
38
43
|
);
|
|
39
44
|
```
|
|
40
45
|
|
|
41
|
-
|
|
46
|
+
The generated local adapter imports the package provider and passes your site config to it.
|
|
42
47
|
|
|
43
48
|
## AI Sidebar
|
|
44
49
|
|
|
45
50
|
When users open the AI chat on desktop, the provider automatically adds padding to prevent content from being hidden behind the sidebar. On mobile, the chat opens as a drawer instead, so no padding is needed.
|
|
46
51
|
|
|
47
|
-
|
|
52
|
+
The provider detects the screen size and chat state.
|
|
48
53
|
|
|
49
54
|
## Toast Notifications
|
|
50
55
|
|