@vercel/geistdocs 1.3.0-canary.88e35b7 → 1.3.0
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 +8 -0
- package/dist/assets/logos/logo-svelte-kit.d.ts.map +1 -0
- package/dist/assets/logos/logo-svelte-kit.js +7 -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
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
# Geistdocs agent instructions
|
|
2
|
+
|
|
3
|
+
This project uses the packaged Geistdocs architecture. The `@vercel/geistdocs` package owns shared runtime behavior; this app owns local content, configuration, adapters, and site-specific routes.
|
|
4
|
+
|
|
5
|
+
Use these instructions when an AI coding agent edits this project.
|
|
6
|
+
|
|
7
|
+
## Architecture
|
|
8
|
+
|
|
9
|
+
- Runtime features come from `@vercel/geistdocs`, including the docs page renderer, layout helpers, MDX components, search, Ask AI, markdown routes, proxy helpers, and source helpers.
|
|
10
|
+
- `@vercel/geistdocs` owns the Ask AI client, server route behavior, and AI SDK v6 runtime dependencies. Do not fork package internals to fit an older app-level `ai` version.
|
|
11
|
+
- Local files are user-owned adapters. They should stay thin and call public package exports from `@vercel/geistdocs/*`.
|
|
12
|
+
- Do not copy package internals into the app to make a customization. Prefer configuring an adapter file or upgrading `@vercel/geistdocs`.
|
|
13
|
+
- Do not deep import from `@vercel/geistdocs/dist` or edit files in `node_modules/@vercel/geistdocs`.
|
|
14
|
+
- Do not edit generated directories such as `.source/`, `.next/`, `node_modules/`, or build output.
|
|
15
|
+
|
|
16
|
+
## Common edit targets
|
|
17
|
+
|
|
18
|
+
| Task | Edit |
|
|
19
|
+
| --- | --- |
|
|
20
|
+
| Configure site title, logo, nav, GitHub links, AI prompt, suggestions, translations, `basePath`, or `siteId` | `geistdocs.tsx` |
|
|
21
|
+
| Add or update documentation pages | `content/docs/**/*.mdx` |
|
|
22
|
+
| Control sidebar order, groups, and labels | `content/docs/meta.json` |
|
|
23
|
+
| Override MDX components | `components/geistdocs/mdx-components.tsx` |
|
|
24
|
+
| Wrap the site provider, analytics, or global client behavior | `components/geistdocs/provider.tsx` |
|
|
25
|
+
| Customize the docs layout shell | `components/geistdocs/docs-layout.tsx` |
|
|
26
|
+
| Configure the Fumadocs source adapter or versioned docs | `lib/geistdocs/source.ts` |
|
|
27
|
+
| Configure Fumadocs collections and source-safe MDX processing | `source.config.ts` |
|
|
28
|
+
| Configure the docs page renderer | `app/[lang]/docs/[[...slug]]/page.tsx` |
|
|
29
|
+
| Configure AI-readable markdown output | `app/[lang]/llms.txt/route.ts`, `app/[lang]/llms.mdx/[[...slug]]/route.ts`, `app/[lang]/sitemap.md/route.ts` |
|
|
30
|
+
| Configure chat or search APIs | `app/api/chat/route.ts`, `app/api/search/route.ts` |
|
|
31
|
+
| Add request handling before or after Geistdocs routing | `proxy.ts` |
|
|
32
|
+
| Edit the marketing home page | `app/[lang]/(home)/**` |
|
|
33
|
+
| Edit shared styles | `app/global.css`, `app/styles/geistdocs.css` |
|
|
34
|
+
|
|
35
|
+
## Content guidelines
|
|
36
|
+
|
|
37
|
+
- Put docs in `content/docs` unless the project has added another source in `lib/geistdocs/source.ts`.
|
|
38
|
+
- Add each new page to `content/docs/meta.json` so it appears in the sidebar.
|
|
39
|
+
- Use MDX frontmatter with at least `title` and `description` for documentation pages.
|
|
40
|
+
- Keep slugs stable unless the task explicitly includes redirects or link updates.
|
|
41
|
+
- When adding translated content, follow the existing locale suffix pattern, such as `page.cn.mdx`.
|
|
42
|
+
- Use `CopyPrompt` when a page should give readers a prompt they can copy into a coding agent.
|
|
43
|
+
|
|
44
|
+
## Routing and proxy guidelines
|
|
45
|
+
|
|
46
|
+
- Keep App Router route files as thin adapters around package helpers such as `createDocsPage`, `createChatRoute`, `createLlmsRoute`, and `createProxy`.
|
|
47
|
+
- Keep `export const config` in `proxy.ts` as a static object. Next.js must parse proxy matchers at build time.
|
|
48
|
+
- Use proxy matcher exclusions that only match `/api` and `/api/...`, such as `api(?:/|$)`. Do not exclude broad prefixes like `api`, because that also excludes routes such as `/api-reference`.
|
|
49
|
+
- Preserve markdown negotiation unless the task explicitly changes AI-readable output. Geistdocs serves `/llms.txt` and per-page Markdown for `.md`, `.mdx`, `Accept: text/markdown`, and AI-agent requests.
|
|
50
|
+
- When adding custom proxy behavior, prefer `before`, `after`, and `markdownRoutes` options on `createProxy` instead of replacing the proxy.
|
|
51
|
+
- Use explicit `markdownRoutes` for root-mounted docs or any site where homepage/app routes coexist with docs routes.
|
|
52
|
+
|
|
53
|
+
## Ask AI and Vertex proxy guidelines
|
|
54
|
+
|
|
55
|
+
- Leave `GEISTDOCS_CHAT_PROXY_URL` unset to use the default AI Gateway path. In that mode, `app/api/chat/route.ts` calls `createChatRoute` without a `proxy` option and uses the local docs search tool during the AI SDK `streamText` loop.
|
|
56
|
+
- Geistdocs Ask AI targets AI SDK v6: `ai` v6 and `@ai-sdk/react` v3. Keep those dependencies on the generated package versions unless a `@vercel/geistdocs` release changes them.
|
|
57
|
+
- If the app uses `ai` or `@ai-sdk/react` for product code outside Geistdocs, migrate that app code separately or let the package manager install separate versions. Do not downgrade Geistdocs Ask AI to match unrelated app code.
|
|
58
|
+
- Set `GEISTDOCS_CHAT_PROXY_URL` only when Ask AI should route through the central Vertex-backed proxy. The value must include the `/vertex` route, such as `https://<geistdocs-platform-deployment>/vertex`.
|
|
59
|
+
- Do not add Vertex credentials to a Geistdocs site. The central platform proxy forwards the Vercel OIDC token in `x-vercel-trusted-oidc-idp-token`; the Vertex deployment should trust the platform Vercel project through Deployment Protection Trusted Sources.
|
|
60
|
+
- Use `GEISTDOCS_CHAT_PROXY_TOKEN` only for a custom proxy that requires bearer authentication. The default Geistdocs platform `/vertex` proxy does not require it.
|
|
61
|
+
- Keep `app/api/chat/route.ts` as a thin adapter around `createChatRoute`. Prefer configuring `GEISTDOCS_CHAT_PROXY_URL` and `GEISTDOCS_CHAT_PROXY_TOKEN` over forking the package chat route.
|
|
62
|
+
- If custom chat client code uses `DefaultChatTransport.prepareSendMessagesRequest`, preserve `messages` in the returned `body` when adding fields such as `currentRoute`. Returning a custom `body` replaces the AI SDK default request body.
|
|
63
|
+
|
|
64
|
+
## Migration guidelines
|
|
65
|
+
|
|
66
|
+
- When migrating from Fumadocs or a custom Geist docs site, inventory `source.config.ts`, route files, `middleware.ts` or `proxy.ts`, `public/llms.txt`, OG routes, Tailwind CSS setup, and required environment variables before editing.
|
|
67
|
+
- Inventory direct app usage of `ai` and `@ai-sdk/react`. Package-owned Ask AI uses AI SDK v6; migrate local AI SDK code separately from Geistdocs route adapters.
|
|
68
|
+
- Import source-config helpers from `@vercel/geistdocs/source-config` in `source.config.ts`. Do not import runtime component entry points from source config.
|
|
69
|
+
- Move existing `middleware.ts` behavior into `createProxy({ before })` or `createProxy({ after })` hooks.
|
|
70
|
+
- Delete `public/llms.txt` when using `createLlmsRoute`; otherwise the static file can mask the App Router route.
|
|
71
|
+
- Set `openGraph.images` in `createDocsPage` only when the app includes the Geistdocs OG route, or override metadata to avoid broken `/og/...` URLs.
|
|
72
|
+
- Add Tailwind CSS v4 `@source` entries for `@vercel/geistdocs` and related runtime dependencies when migrating styles.
|
|
73
|
+
- Add local fallbacks for production-only environment variables so migration builds do not require production secrets.
|
|
74
|
+
|
|
75
|
+
## Package updates
|
|
76
|
+
|
|
77
|
+
- Use `pnpm exec geistdocs update` to update package-based Geistdocs projects.
|
|
78
|
+
- `geistdocs update` updates the `@vercel/geistdocs` dependency. It does not overwrite local adapter files.
|
|
79
|
+
- Review dependency changes and run the verification commands before committing an update.
|
|
80
|
+
|
|
81
|
+
## Commands
|
|
82
|
+
|
|
83
|
+
- Start development: `pnpm dev`
|
|
84
|
+
- Build for production: `pnpm build`
|
|
85
|
+
- Start the built app: `pnpm start`
|
|
86
|
+
- Regenerate Fumadocs output after dependency installation: `pnpm postinstall`
|
|
87
|
+
- Update Geistdocs: `pnpm exec geistdocs update`
|
|
88
|
+
- Run translations if configured: `pnpm translate`
|
|
89
|
+
|
|
90
|
+
## Verification
|
|
91
|
+
|
|
92
|
+
- Run `pnpm build` after changing routes, config, source setup, MDX components, or package versions.
|
|
93
|
+
- Run `pnpm dev` and open the changed pages when visual layout, navigation, or MDX rendering changes.
|
|
94
|
+
- Check both `/docs` and AI-readable routes such as `/llms.txt` or a page-level `.md` URL when changing content routing or proxy behavior.
|
|
95
|
+
- Confirm no secrets were added to source files. Use `.env.local` for local values and keep it out of Git.
|
|
@@ -16,9 +16,7 @@ export const CenteredSection = ({
|
|
|
16
16
|
<h2 className="font-semibold text-xl tracking-tight sm:text-2xl md:text-3xl lg:text-[40px]">
|
|
17
17
|
{title}
|
|
18
18
|
</h2>
|
|
19
|
-
<p className="text-balance text-
|
|
20
|
-
{description}
|
|
21
|
-
</p>
|
|
19
|
+
<p className="text-balance text-gray-800 text-lg">{description}</p>
|
|
22
20
|
</div>
|
|
23
21
|
|
|
24
22
|
{children}
|
|
@@ -12,13 +12,13 @@ export const Hero = ({ badge, title, description, children }: HeroProps) => (
|
|
|
12
12
|
<section className="mt-(--fd-nav-height) space-y-6 px-4 pt-16 pb-16 text-center sm:pt-24">
|
|
13
13
|
<div className="mx-auto w-full max-w-4xl space-y-5">
|
|
14
14
|
<Badge className="rounded-full" variant="secondary">
|
|
15
|
-
<div className="size-2 rounded-full bg-
|
|
15
|
+
<div className="size-2 rounded-full bg-gray-800" />
|
|
16
16
|
<p>{badge}</p>
|
|
17
17
|
</Badge>
|
|
18
18
|
<h1 className="text-balance text-center font-semibold text-[40px]! leading-[1.1] tracking-tight sm:text-5xl! lg:font-semibold xl:text-6xl!">
|
|
19
19
|
{title}
|
|
20
20
|
</h1>
|
|
21
|
-
<p className="mx-auto max-w-3xl text-balance text-
|
|
21
|
+
<p className="mx-auto max-w-3xl text-balance text-gray-800 leading-relaxed sm:text-xl">
|
|
22
22
|
{description}
|
|
23
23
|
</p>
|
|
24
24
|
</div>
|
|
@@ -16,9 +16,7 @@ export const OneTwoSection = ({
|
|
|
16
16
|
<h2 className="font-semibold text-xl tracking-tight sm:text-2xl md:text-3xl">
|
|
17
17
|
{title}
|
|
18
18
|
</h2>
|
|
19
|
-
<p className="mt-2 text-balance text-
|
|
20
|
-
{description}
|
|
21
|
-
</p>
|
|
19
|
+
<p className="mt-2 text-balance text-gray-800 text-lg">{description}</p>
|
|
22
20
|
</div>
|
|
23
21
|
<div className="sm:col-span-2 sm:p-12">{children}</div>
|
|
24
22
|
</div>
|
|
@@ -18,19 +18,17 @@ export const Templates = ({ title, description, data }: TemplatesProps) => (
|
|
|
18
18
|
<h2 className="font-semibold text-xl tracking-tight sm:text-2xl md:text-3xl lg:text-[40px]">
|
|
19
19
|
{title}
|
|
20
20
|
</h2>
|
|
21
|
-
<p className="text-balance text-
|
|
22
|
-
{description}
|
|
23
|
-
</p>
|
|
21
|
+
<p className="text-balance text-gray-800 text-lg">{description}</p>
|
|
24
22
|
</div>
|
|
25
23
|
<div className="grid gap-8 md:grid-cols-3">
|
|
26
24
|
{data.map((item) => (
|
|
27
25
|
<a
|
|
28
|
-
className="group flex-col overflow-hidden rounded-lg border bg-background p-4"
|
|
26
|
+
className="group flex-col overflow-hidden rounded-lg border bg-background-100 p-4"
|
|
29
27
|
href={item.link}
|
|
30
28
|
key={item.title}
|
|
31
29
|
>
|
|
32
30
|
<h3 className="font-medium tracking-tight">{item.title}</h3>
|
|
33
|
-
<p className="line-clamp-2 text-
|
|
31
|
+
<p className="line-clamp-2 text-gray-800 text-sm">
|
|
34
32
|
{item.description}
|
|
35
33
|
</p>
|
|
36
34
|
<Image
|
|
@@ -13,7 +13,7 @@ export const TextGridSection = ({ data }: TextGridSectionProps) => (
|
|
|
13
13
|
<h3 className="mb-2 font-semibold text-lg tracking-tight">
|
|
14
14
|
{item.title}
|
|
15
15
|
</h3>
|
|
16
|
-
<p className="text-
|
|
16
|
+
<p className="text-gray-800">{item.description}</p>
|
|
17
17
|
</div>
|
|
18
18
|
))}
|
|
19
19
|
</div>
|
|
@@ -1,13 +1,14 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { GeistdocsHomeLayout } from "@vercel/geistdocs/home-layout";
|
|
2
|
+
import { config } from "@/lib/geistdocs/config";
|
|
2
3
|
import { source } from "@/lib/geistdocs/source";
|
|
3
4
|
|
|
4
5
|
const Layout = async ({ children, params }: LayoutProps<"/[lang]">) => {
|
|
5
6
|
const { lang } = await params;
|
|
6
7
|
|
|
7
8
|
return (
|
|
8
|
-
<
|
|
9
|
+
<GeistdocsHomeLayout config={config} tree={source.pageTree[lang]}>
|
|
9
10
|
<div className="pt-0 pb-32">{children}</div>
|
|
10
|
-
</
|
|
11
|
+
</GeistdocsHomeLayout>
|
|
11
12
|
);
|
|
12
13
|
};
|
|
13
14
|
|
|
@@ -105,13 +105,13 @@ const HomePage = () => (
|
|
|
105
105
|
description="Description of centered section"
|
|
106
106
|
title="Centered Section"
|
|
107
107
|
>
|
|
108
|
-
<div className="aspect-video rounded-lg border bg-background" />
|
|
108
|
+
<div className="aspect-video rounded-lg border bg-background-100" />
|
|
109
109
|
</CenteredSection>
|
|
110
110
|
<OneTwoSection
|
|
111
111
|
description="Description of one/two section"
|
|
112
112
|
title="One/Two Section"
|
|
113
113
|
>
|
|
114
|
-
<div className="aspect-video rounded-lg border bg-background" />
|
|
114
|
+
<div className="aspect-video rounded-lg border bg-background-100" />
|
|
115
115
|
</OneTwoSection>
|
|
116
116
|
<Templates
|
|
117
117
|
data={templates}
|
|
@@ -1,12 +1,15 @@
|
|
|
1
|
+
import { MobileDocsBar } from "@vercel/geistdocs/mobile-docs-bar";
|
|
1
2
|
import { createDocsPage } from "@vercel/geistdocs/pages/docs";
|
|
2
3
|
import { getMDXComponents } from "@/components/geistdocs/mdx-components";
|
|
3
|
-
import { MobileDocsBar } from "@/components/geistdocs/mobile-docs-bar";
|
|
4
4
|
import { config } from "@/lib/geistdocs/config";
|
|
5
5
|
import { geistdocsSource } from "@/lib/geistdocs/source";
|
|
6
6
|
|
|
7
7
|
const docsPage = createDocsPage({
|
|
8
8
|
config,
|
|
9
9
|
mdx: ({ link }) => getMDXComponents({ a: link }),
|
|
10
|
+
openGraph: {
|
|
11
|
+
images: true,
|
|
12
|
+
},
|
|
10
13
|
source: geistdocsSource,
|
|
11
14
|
tableOfContentPopover: {
|
|
12
15
|
enabled: false,
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import "../global.css";
|
|
2
|
-
import { Footer } from "
|
|
3
|
-
import { Navbar } from "
|
|
2
|
+
import { Footer } from "@vercel/geistdocs/footer";
|
|
3
|
+
import { Navbar } from "@vercel/geistdocs/navbar";
|
|
4
4
|
import { GeistdocsProvider } from "@/components/geistdocs/provider";
|
|
5
|
-
import {
|
|
5
|
+
import { config } from "@/lib/geistdocs/config";
|
|
6
6
|
import { mono, sans } from "@/lib/geistdocs/fonts";
|
|
7
7
|
import { cn } from "@/lib/utils";
|
|
8
8
|
|
|
@@ -16,10 +16,10 @@ const Layout = async ({ children, params }: LayoutProps<"/[lang]">) => {
|
|
|
16
16
|
suppressHydrationWarning
|
|
17
17
|
>
|
|
18
18
|
<body>
|
|
19
|
-
<GeistdocsProvider basePath={basePath} lang={lang}>
|
|
20
|
-
<Navbar />
|
|
19
|
+
<GeistdocsProvider basePath={config.basePath} lang={lang}>
|
|
20
|
+
<Navbar config={config} />
|
|
21
21
|
{children}
|
|
22
|
-
<Footer />
|
|
22
|
+
<Footer config={config} />
|
|
23
23
|
</GeistdocsProvider>
|
|
24
24
|
</body>
|
|
25
25
|
</html>
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import { createSitemapMarkdownRoute } from "@vercel/geistdocs/routes/sitemap";
|
|
2
2
|
import { config } from "@/lib/geistdocs/config";
|
|
3
|
-
import {
|
|
3
|
+
import { geistdocsSource } from "@/lib/geistdocs/source";
|
|
4
4
|
|
|
5
5
|
export const { GET, generateStaticParams, revalidate, dynamic } =
|
|
6
6
|
createSitemapMarkdownRoute({
|
|
7
7
|
config,
|
|
8
|
-
source,
|
|
8
|
+
sources: [{ source: geistdocsSource }],
|
|
9
9
|
});
|
|
@@ -2,7 +2,18 @@ import { createChatRoute } from "@vercel/geistdocs/routes/chat";
|
|
|
2
2
|
import { config } from "@/lib/geistdocs/config";
|
|
3
3
|
import { geistdocsSource } from "@/lib/geistdocs/source";
|
|
4
4
|
|
|
5
|
+
const chatProxyUrl = process.env.GEISTDOCS_CHAT_PROXY_URL;
|
|
6
|
+
const chatProxyToken = process.env.GEISTDOCS_CHAT_PROXY_TOKEN;
|
|
7
|
+
|
|
5
8
|
export const { POST, maxDuration } = createChatRoute({
|
|
6
9
|
config,
|
|
7
|
-
|
|
10
|
+
proxy: chatProxyUrl
|
|
11
|
+
? {
|
|
12
|
+
url: chatProxyUrl,
|
|
13
|
+
headers: chatProxyToken
|
|
14
|
+
? { Authorization: `Bearer ${chatProxyToken}` }
|
|
15
|
+
: undefined,
|
|
16
|
+
}
|
|
17
|
+
: undefined,
|
|
18
|
+
sources: [geistdocsSource],
|
|
8
19
|
});
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { createSearchRoute } from "@vercel/geistdocs/routes/search";
|
|
2
2
|
import { config } from "@/lib/geistdocs/config";
|
|
3
|
-
import {
|
|
3
|
+
import { geistdocsSource } from "@/lib/geistdocs/source";
|
|
4
4
|
|
|
5
|
-
export const GET = createSearchRoute({ config,
|
|
5
|
+
export const GET = createSearchRoute({ config, sources: [geistdocsSource] });
|