@vercel/geistdocs 1.25.0 → 1.25.1-canary.bd8995b
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/cli/index.js +1 -1
- package/dist/components/callout.d.ts.map +1 -1
- package/dist/components/callout.js +1 -1
- package/dist/components/code-block-tabs.d.ts +5 -2
- package/dist/components/code-block-tabs.d.ts.map +1 -1
- package/dist/components/code-block-tabs.js +28 -5
- package/dist/components/code-block.d.ts +2 -6
- package/dist/components/code-block.d.ts.map +1 -1
- package/dist/components/code-block.js +22 -68
- package/dist/components/command-prompt.d.ts.map +1 -1
- package/dist/components/command-prompt.js +3 -3
- package/dist/components/copy-prompt.d.ts.map +1 -1
- package/dist/components/copy-prompt.js +4 -4
- package/dist/components/mermaid.js +1 -1
- package/dist/controls.d.ts +8 -4
- package/dist/controls.d.ts.map +1 -1
- package/dist/controls.js +14 -14
- package/dist/footer.d.ts.map +1 -1
- package/dist/footer.js +6 -6
- package/dist/home-layout.js +1 -1
- package/dist/internal/chat/conversation.d.ts +4 -3
- package/dist/internal/chat/conversation.d.ts.map +1 -1
- package/dist/internal/chat/conversation.js +5 -5
- package/dist/internal/chat/copy-chat.d.ts.map +1 -1
- package/dist/internal/chat/copy-chat.js +13 -10
- package/dist/internal/chat/dots-spinner.d.ts +5 -0
- package/dist/internal/chat/dots-spinner.d.ts.map +1 -0
- package/dist/internal/chat/dots-spinner.js +15 -0
- package/dist/internal/chat/message-metadata.d.ts.map +1 -1
- package/dist/internal/chat/message-metadata.js +8 -7
- package/dist/internal/chat/message.d.ts.map +1 -1
- package/dist/internal/chat/message.js +5 -5
- package/dist/internal/chat/prompt-input.d.ts +1 -1
- package/dist/internal/chat/prompt-input.d.ts.map +1 -1
- package/dist/internal/chat/prompt-input.js +25 -27
- package/dist/internal/chat/shell.d.ts.map +1 -1
- package/dist/internal/chat/shell.js +27 -19
- package/dist/internal/chat/sources.d.ts +3 -1
- package/dist/internal/chat/sources.d.ts.map +1 -1
- package/dist/internal/chat/sources.js +6 -6
- package/dist/internal/chat/suggestion.d.ts +11 -6
- package/dist/internal/chat/suggestion.d.ts.map +1 -1
- package/dist/internal/chat/suggestion.js +5 -5
- package/dist/internal/docs-page-error-boundary.d.ts.map +1 -1
- package/dist/internal/docs-page-error-boundary.js +3 -3
- package/dist/internal/external-arrow.d.ts.map +1 -1
- package/dist/internal/external-arrow.js +1 -1
- package/dist/internal/footer/rss-button.d.ts.map +1 -1
- package/dist/internal/footer/rss-button.js +3 -3
- package/dist/internal/github-button.d.ts.map +1 -1
- package/dist/internal/github-button.js +3 -3
- package/dist/internal/navbar/desktop-menu.d.ts.map +1 -1
- package/dist/internal/navbar/desktop-menu.js +3 -3
- package/dist/internal/navbar/mobile-menu.d.ts.map +1 -1
- package/dist/internal/navbar/mobile-menu.js +3 -3
- package/dist/internal/navbar/navbar-logo.d.ts.map +1 -1
- package/dist/internal/navbar/navbar-logo.js +6 -8
- package/dist/internal/navbar/navbar-shell.d.ts.map +1 -1
- package/dist/internal/navbar/navbar-shell.js +1 -1
- package/dist/internal/page-actions-client.d.ts.map +1 -1
- package/dist/internal/page-actions-client.js +19 -20
- package/dist/internal/page-breadcrumb.d.ts.map +1 -1
- package/dist/internal/page-breadcrumb.js +3 -3
- package/dist/internal/page-footer.d.ts.map +1 -1
- package/dist/internal/page-footer.js +2 -2
- package/dist/internal/provider-client.d.ts.map +1 -1
- package/dist/internal/provider-client.js +9 -9
- package/dist/internal/search.d.ts.map +1 -1
- package/dist/internal/search.js +2 -2
- package/dist/internal/sidebar-tree.d.ts.map +1 -1
- package/dist/internal/sidebar-tree.js +9 -7
- package/dist/internal/sidebar.d.ts.map +1 -1
- package/dist/internal/sidebar.js +6 -8
- package/dist/internal/toc-items.d.ts.map +1 -1
- package/dist/internal/toc-items.js +1 -1
- package/dist/internal/ui/dropdown-menu.d.ts.map +1 -1
- package/dist/internal/ui/dropdown-menu.js +5 -5
- package/dist/internal/ui/navigation-menu.d.ts.map +1 -1
- package/dist/internal/ui/navigation-menu.js +2 -2
- package/dist/internal/ui/popover.d.ts.map +1 -1
- package/dist/internal/ui/popover.js +1 -1
- package/dist/internal/ui/scroll-area.d.ts.map +1 -1
- package/dist/internal/ui/scroll-area.js +1 -1
- package/dist/layout.js +1 -1
- package/dist/mdx.d.ts.map +1 -1
- package/dist/mdx.js +2 -1
- package/dist/mobile-docs-bar.d.ts.map +1 -1
- package/dist/mobile-docs-bar.js +1 -2
- package/dist/navbar.js +3 -2
- package/dist/pages/docs.d.ts.map +1 -1
- package/dist/pages/docs.js +1 -1
- package/dist/source.d.ts.map +1 -1
- package/dist/source.js +0 -2
- package/dist/versions.d.ts.map +1 -1
- package/dist/versions.js +5 -5
- package/docs/agents.md +1 -2
- package/docs/llms.txt +88 -80
- package/docs/manifest.json +1 -10
- package/docs/pages/migration.md +5 -7
- package/docs/pages/syntax.md +79 -5
- package/docs/pages/versioned-docs.md +3 -3
- package/docs/sitemap.md +0 -1
- package/package.json +10 -102
- package/styles.css +3 -2
- package/template/AGENTS.md +10 -0
- package/template/app/[lang]/(home)/components/hero.tsx +2 -2
- package/template/app/[lang]/(home)/components/one-two-section.tsx +9 -1
- package/template/app/[lang]/(home)/components/text-grid-section.tsx +1 -1
- package/template/app/[lang]/(home)/page.tsx +5 -6
- package/template/app/[lang]/layout.tsx +7 -4
- package/template/app/styles/geistdocs.css +17 -14
- package/template/content/docs/configuration.cn.mdx +2 -2
- package/template/content/docs/migration.mdx +5 -7
- package/template/content/docs/syntax.mdx +79 -5
- package/template/content/docs/versioned-docs.mdx +3 -3
- package/template/lib/geistdocs/config.tsx +0 -5
- package/template/next.config.ts +16 -2
- package/template/package.json +5 -7
- package/theme.css +68 -662
- package/dist/assets/icons/icon-acronym-ts.d.ts +0 -5
- package/dist/assets/icons/icon-acronym-ts.d.ts.map +0 -1
- package/dist/assets/icons/icon-acronym-ts.js +0 -4
- package/dist/assets/icons/icon-agents.d.ts +0 -5
- package/dist/assets/icons/icon-agents.d.ts.map +0 -1
- package/dist/assets/icons/icon-agents.js +0 -4
- package/dist/assets/icons/icon-api.d.ts +0 -5
- package/dist/assets/icons/icon-api.d.ts.map +0 -1
- package/dist/assets/icons/icon-api.js +0 -4
- package/dist/assets/icons/icon-arrow-up-right-small.d.ts +0 -8
- package/dist/assets/icons/icon-arrow-up-right-small.d.ts.map +0 -1
- package/dist/assets/icons/icon-arrow-up-right-small.js +0 -4
- package/dist/assets/icons/icon-arrow-up-right.d.ts +0 -5
- package/dist/assets/icons/icon-arrow-up-right.d.ts.map +0 -1
- package/dist/assets/icons/icon-arrow-up-right.js +0 -4
- package/dist/assets/icons/icon-check.d.ts +0 -5
- package/dist/assets/icons/icon-check.d.ts.map +0 -1
- package/dist/assets/icons/icon-check.js +0 -4
- package/dist/assets/icons/icon-chevron-down-small.d.ts +0 -8
- package/dist/assets/icons/icon-chevron-down-small.d.ts.map +0 -1
- package/dist/assets/icons/icon-chevron-down-small.js +0 -7
- package/dist/assets/icons/icon-chevron-right.d.ts +0 -5
- package/dist/assets/icons/icon-chevron-right.d.ts.map +0 -1
- package/dist/assets/icons/icon-chevron-right.js +0 -4
- package/dist/assets/icons/icon-clock.d.ts +0 -5
- package/dist/assets/icons/icon-clock.d.ts.map +0 -1
- package/dist/assets/icons/icon-clock.js +0 -4
- package/dist/assets/icons/icon-copy.d.ts +0 -5
- package/dist/assets/icons/icon-copy.d.ts.map +0 -1
- package/dist/assets/icons/icon-copy.js +0 -4
- package/dist/assets/icons/icon-display-small.d.ts +0 -5
- package/dist/assets/icons/icon-display-small.d.ts.map +0 -1
- package/dist/assets/icons/icon-display-small.js +0 -4
- package/dist/assets/icons/icon-display.d.ts +0 -5
- package/dist/assets/icons/icon-display.d.ts.map +0 -1
- package/dist/assets/icons/icon-display.js +0 -4
- package/dist/assets/icons/icon-file-text.d.ts +0 -5
- package/dist/assets/icons/icon-file-text.d.ts.map +0 -1
- package/dist/assets/icons/icon-file-text.js +0 -4
- package/dist/assets/icons/icon-folder-open.d.ts +0 -5
- package/dist/assets/icons/icon-folder-open.d.ts.map +0 -1
- package/dist/assets/icons/icon-folder-open.js +0 -4
- package/dist/assets/icons/icon-linked.d.ts +0 -5
- package/dist/assets/icons/icon-linked.d.ts.map +0 -1
- package/dist/assets/icons/icon-linked.js +0 -4
- package/dist/assets/icons/icon-logs.d.ts +0 -5
- package/dist/assets/icons/icon-logs.d.ts.map +0 -1
- package/dist/assets/icons/icon-logs.js +0 -4
- package/dist/assets/icons/icon-menu-alt.d.ts +0 -5
- package/dist/assets/icons/icon-menu-alt.d.ts.map +0 -1
- package/dist/assets/icons/icon-menu-alt.js +0 -4
- package/dist/assets/icons/icon-message.d.ts +0 -5
- package/dist/assets/icons/icon-message.d.ts.map +0 -1
- package/dist/assets/icons/icon-message.js +0 -4
- package/dist/assets/icons/icon-moon-small.d.ts +0 -5
- package/dist/assets/icons/icon-moon-small.d.ts.map +0 -1
- package/dist/assets/icons/icon-moon-small.js +0 -4
- package/dist/assets/icons/icon-moon.d.ts +0 -5
- package/dist/assets/icons/icon-moon.d.ts.map +0 -1
- package/dist/assets/icons/icon-moon.js +0 -4
- package/dist/assets/icons/icon-openai.d.ts +0 -5
- package/dist/assets/icons/icon-openai.d.ts.map +0 -1
- package/dist/assets/icons/icon-openai.js +0 -4
- package/dist/assets/icons/icon-plus-circle.d.ts +0 -5
- package/dist/assets/icons/icon-plus-circle.d.ts.map +0 -1
- package/dist/assets/icons/icon-plus-circle.js +0 -4
- package/dist/assets/icons/icon-refresh-counter-clockwise.d.ts +0 -5
- package/dist/assets/icons/icon-refresh-counter-clockwise.d.ts.map +0 -1
- package/dist/assets/icons/icon-refresh-counter-clockwise.js +0 -4
- package/dist/assets/icons/icon-robot.d.ts +0 -5
- package/dist/assets/icons/icon-robot.d.ts.map +0 -1
- package/dist/assets/icons/icon-robot.js +0 -4
- package/dist/assets/icons/icon-sandbox.d.ts +0 -5
- package/dist/assets/icons/icon-sandbox.d.ts.map +0 -1
- package/dist/assets/icons/icon-sandbox.js +0 -4
- package/dist/assets/icons/icon-slash-forward.d.ts +0 -8
- package/dist/assets/icons/icon-slash-forward.d.ts.map +0 -1
- package/dist/assets/icons/icon-slash-forward.js +0 -4
- package/dist/assets/icons/icon-sparkles.d.ts +0 -5
- package/dist/assets/icons/icon-sparkles.d.ts.map +0 -1
- package/dist/assets/icons/icon-sparkles.js +0 -4
- package/dist/assets/icons/icon-sun-small.d.ts +0 -5
- package/dist/assets/icons/icon-sun-small.d.ts.map +0 -1
- package/dist/assets/icons/icon-sun-small.js +0 -4
- package/dist/assets/icons/icon-sun.d.ts +0 -5
- package/dist/assets/icons/icon-sun.d.ts.map +0 -1
- package/dist/assets/icons/icon-sun.js +0 -4
- package/dist/assets/icons/icon-trash.d.ts +0 -5
- package/dist/assets/icons/icon-trash.d.ts.map +0 -1
- package/dist/assets/icons/icon-trash.js +0 -4
- package/dist/assets/icons/icon-user.d.ts +0 -5
- package/dist/assets/icons/icon-user.d.ts.map +0 -1
- package/dist/assets/icons/icon-user.js +0 -4
- package/dist/assets/icons/icon-workflow.d.ts +0 -5
- package/dist/assets/icons/icon-workflow.d.ts.map +0 -1
- package/dist/assets/icons/icon-workflow.js +0 -4
- package/dist/assets/icons/icon-wrench.d.ts +0 -5
- package/dist/assets/icons/icon-wrench.d.ts.map +0 -1
- package/dist/assets/icons/icon-wrench.js +0 -4
- package/dist/assets/icons/index.d.ts +0 -35
- package/dist/assets/icons/index.d.ts.map +0 -1
- package/dist/assets/icons/index.js +0 -35
- package/dist/assets/logos/index.d.ts +0 -17
- package/dist/assets/logos/index.d.ts.map +0 -1
- package/dist/assets/logos/index.js +0 -17
- package/dist/assets/logos/logo-ai-elements.d.ts +0 -5
- package/dist/assets/logos/logo-ai-elements.d.ts.map +0 -1
- package/dist/assets/logos/logo-ai-elements.js +0 -5
- package/dist/assets/logos/logo-ai-sdk.d.ts +0 -5
- package/dist/assets/logos/logo-ai-sdk.d.ts.map +0 -1
- package/dist/assets/logos/logo-ai-sdk.js +0 -5
- package/dist/assets/logos/logo-chat-sdk.d.ts +0 -5
- package/dist/assets/logos/logo-chat-sdk.d.ts.map +0 -1
- package/dist/assets/logos/logo-chat-sdk.js +0 -5
- package/dist/assets/logos/logo-eve.d.ts +0 -5
- package/dist/assets/logos/logo-eve.d.ts.map +0 -1
- package/dist/assets/logos/logo-eve.js +0 -5
- package/dist/assets/logos/logo-flags-sdk.d.ts +0 -5
- package/dist/assets/logos/logo-flags-sdk.d.ts.map +0 -1
- package/dist/assets/logos/logo-flags-sdk.js +0 -5
- package/dist/assets/logos/logo-icon-vercel.d.ts +0 -5
- package/dist/assets/logos/logo-icon-vercel.d.ts.map +0 -1
- package/dist/assets/logos/logo-icon-vercel.js +0 -4
- package/dist/assets/logos/logo-nextjs.d.ts +0 -5
- package/dist/assets/logos/logo-nextjs.d.ts.map +0 -1
- package/dist/assets/logos/logo-nextjs.js +0 -9
- package/dist/assets/logos/logo-streamdown.d.ts +0 -5
- package/dist/assets/logos/logo-streamdown.d.ts.map +0 -1
- package/dist/assets/logos/logo-streamdown.js +0 -5
- package/dist/assets/logos/logo-svelte-kit.d.ts +0 -5
- package/dist/assets/logos/logo-svelte-kit.d.ts.map +0 -1
- package/dist/assets/logos/logo-svelte-kit.js +0 -4
- package/dist/assets/logos/logo-turborepo.d.ts +0 -5
- package/dist/assets/logos/logo-turborepo.d.ts.map +0 -1
- package/dist/assets/logos/logo-turborepo.js +0 -5
- package/dist/assets/logos/logo-vercel-oss.d.ts +0 -5
- package/dist/assets/logos/logo-vercel-oss.d.ts.map +0 -1
- package/dist/assets/logos/logo-vercel-oss.js +0 -4
- package/dist/assets/logos/logo-workflow-sdk.d.ts +0 -5
- package/dist/assets/logos/logo-workflow-sdk.d.ts.map +0 -1
- package/dist/assets/logos/logo-workflow-sdk.js +0 -5
- package/dist/components/badge.d.ts +0 -11
- package/dist/components/badge.d.ts.map +0 -1
- package/dist/components/badge.js +0 -22
- package/dist/components/button-group.d.ts +0 -2
- package/dist/components/button-group.d.ts.map +0 -1
- package/dist/components/button-group.js +0 -2
- package/dist/components/button.d.ts +0 -2
- package/dist/components/button.d.ts.map +0 -1
- package/dist/components/button.js +0 -2
- package/dist/components/card.d.ts +0 -2
- package/dist/components/card.d.ts.map +0 -1
- package/dist/components/card.js +0 -2
- package/dist/components/dialog.d.ts +0 -13
- package/dist/components/dialog.d.ts.map +0 -1
- package/dist/components/dialog.js +0 -35
- package/dist/components/drawer.d.ts +0 -2
- package/dist/components/drawer.d.ts.map +0 -1
- package/dist/components/drawer.js +0 -3
- package/dist/components/input-group.d.ts +0 -2
- package/dist/components/input-group.d.ts.map +0 -1
- package/dist/components/input-group.js +0 -3
- package/dist/components/input.d.ts +0 -2
- package/dist/components/input.d.ts.map +0 -1
- package/dist/components/input.js +0 -2
- package/dist/components/kbd.d.ts +0 -2
- package/dist/components/kbd.d.ts.map +0 -1
- package/dist/components/kbd.js +0 -2
- package/dist/components/separator.d.ts +0 -2
- package/dist/components/separator.d.ts.map +0 -1
- package/dist/components/separator.js +0 -3
- package/dist/components/sheet.d.ts +0 -2
- package/dist/components/sheet.d.ts.map +0 -1
- package/dist/components/sheet.js +0 -3
- package/dist/components/sonner.d.ts +0 -2
- package/dist/components/sonner.d.ts.map +0 -1
- package/dist/components/sonner.js +0 -3
- package/dist/components/spinner.d.ts +0 -2
- package/dist/components/spinner.d.ts.map +0 -1
- package/dist/components/spinner.js +0 -2
- package/dist/components/switch.d.ts +0 -11
- package/dist/components/switch.d.ts.map +0 -1
- package/dist/components/switch.js +0 -12
- package/dist/components/textarea.d.ts +0 -2
- package/dist/components/textarea.d.ts.map +0 -1
- package/dist/components/textarea.js +0 -2
- package/dist/components/theme-aware-image.d.ts +0 -12
- package/dist/components/theme-aware-image.d.ts.map +0 -1
- package/dist/components/theme-aware-image.js +0 -8
- package/dist/components/theme-switcher.d.ts +0 -8
- package/dist/components/theme-switcher.d.ts.map +0 -1
- package/dist/components/theme-switcher.js +0 -37
- package/dist/components/tooltip.d.ts +0 -2
- package/dist/components/tooltip.d.ts.map +0 -1
- package/dist/components/tooltip.js +0 -3
- package/dist/internal/chat/shimmer.d.ts +0 -11
- package/dist/internal/chat/shimmer.d.ts.map +0 -1
- package/dist/internal/chat/shimmer.js +0 -22
- package/dist/internal/cn.d.ts +0 -3
- package/dist/internal/cn.d.ts.map +0 -1
- package/dist/internal/cn.js +0 -47
- package/dist/internal/ui/button-group.d.ts +0 -13
- package/dist/internal/ui/button-group.d.ts.map +0 -1
- package/dist/internal/ui/button-group.js +0 -26
- package/dist/internal/ui/button.d.ts +0 -12
- package/dist/internal/ui/button.d.ts.map +0 -1
- package/dist/internal/ui/button.js +0 -33
- package/dist/internal/ui/card.d.ts +0 -6
- package/dist/internal/ui/card.d.ts.map +0 -1
- package/dist/internal/ui/card.js +0 -14
- package/dist/internal/ui/drawer.d.ts +0 -8
- package/dist/internal/ui/drawer.d.ts.map +0 -1
- package/dist/internal/ui/drawer.js +0 -19
- package/dist/internal/ui/input-group.d.ts +0 -15
- package/dist/internal/ui/input-group.d.ts.map +0 -1
- package/dist/internal/ui/input-group.js +0 -44
- package/dist/internal/ui/input.d.ts +0 -3
- package/dist/internal/ui/input.d.ts.map +0 -1
- package/dist/internal/ui/input.js +0 -5
- package/dist/internal/ui/kbd.d.ts +0 -4
- package/dist/internal/ui/kbd.d.ts.map +0 -1
- package/dist/internal/ui/kbd.js +0 -8
- package/dist/internal/ui/separator.d.ts +0 -4
- package/dist/internal/ui/separator.d.ts.map +0 -1
- package/dist/internal/ui/separator.js +0 -7
- package/dist/internal/ui/sheet.d.ts +0 -13
- package/dist/internal/ui/sheet.d.ts.map +0 -1
- package/dist/internal/ui/sheet.js +0 -24
- package/dist/internal/ui/sonner.d.ts +0 -3
- package/dist/internal/ui/sonner.d.ts.map +0 -1
- package/dist/internal/ui/sonner.js +0 -20
- package/dist/internal/ui/spinner.d.ts +0 -3
- package/dist/internal/ui/spinner.d.ts.map +0 -1
- package/dist/internal/ui/spinner.js +0 -6
- package/dist/internal/ui/textarea.d.ts +0 -3
- package/dist/internal/ui/textarea.d.ts.map +0 -1
- package/dist/internal/ui/textarea.js +0 -5
- package/dist/internal/ui/tooltip.d.ts +0 -7
- package/dist/internal/ui/tooltip.d.ts.map +0 -1
- package/dist/internal/ui/tooltip.js +0 -16
- package/docs/pages/theme-aware-image.md +0 -59
- package/template/app/[lang]/(home)/components/centered-section.tsx +0 -32
- package/template/content/docs/theme-aware-image.mdx +0 -57
|
@@ -181,7 +181,7 @@ Each version can define an `icon` to override the default current/previous versi
|
|
|
181
181
|
Use `GeistdocsRouteSelect` for framework, product, or route switchers that should not use version-specific labels:
|
|
182
182
|
|
|
183
183
|
```tsx
|
|
184
|
-
import {
|
|
184
|
+
import { LogoIconNextSvg, LogoSvelte } from "@vercel/geistcn-assets/logos";
|
|
185
185
|
import { GeistdocsRouteSelect } from "@vercel/geistdocs/versions";
|
|
186
186
|
|
|
187
187
|
<GeistdocsRouteSelect
|
|
@@ -192,14 +192,14 @@ import { GeistdocsRouteSelect } from "@vercel/geistdocs/versions";
|
|
|
192
192
|
id: "nextjs",
|
|
193
193
|
label: "Next.js",
|
|
194
194
|
description: "React framework",
|
|
195
|
-
icon: <
|
|
195
|
+
icon: <LogoIconNextSvg size={18} />,
|
|
196
196
|
href: "/:path*",
|
|
197
197
|
},
|
|
198
198
|
{
|
|
199
199
|
id: "sveltekit",
|
|
200
200
|
label: "SvelteKit",
|
|
201
201
|
description: "Svelte framework",
|
|
202
|
-
icon: <
|
|
202
|
+
icon: <LogoSvelte height={18} />,
|
|
203
203
|
routePrefix: "/sveltekit",
|
|
204
204
|
href: "/sveltekit/:path*",
|
|
205
205
|
},
|
package/docs/sitemap.md
CHANGED
|
@@ -24,4 +24,3 @@ Use it to choose focused page files from `docs/pages/` before reading the full `
|
|
|
24
24
|
- [Open in Chat](pages/open-in-chat.md) | URL: /docs/open-in-chat | Type: conceptual | Summary: Transfer documentation context to AI chat platforms like ChatGPT, Claude, Cursor, and v0 with a single click.
|
|
25
25
|
- [RSS](pages/rss.md) | URL: /docs/rss | Type: conceptual | Summary: An automatically generated RSS 2.0 feed that keeps users informed when documentation is published or updated.
|
|
26
26
|
- [Table of contents](pages/table-of-contents.md) | URL: /docs/table-of-contents | Type: reference | Summary: Geistdocs builds the "On this page" outline from your headings, indents sub-headings under their parent, and tracks the active section along a straight vertical guide rail.
|
|
27
|
-
- [Theme-Aware Image](pages/theme-aware-image.md) | URL: /docs/theme-aware-image | Type: reference | Summary: A component that swaps images based on the active theme, built on top of Next.js Image.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vercel/geistdocs",
|
|
3
3
|
"description": "Runtime and CLI for Geistdocs projects.",
|
|
4
|
-
"version": "1.25.
|
|
4
|
+
"version": "1.25.1-canary.bd8995b",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
@@ -131,26 +131,10 @@
|
|
|
131
131
|
"types": "./dist/shiki-theme.d.ts",
|
|
132
132
|
"default": "./dist/shiki-theme.js"
|
|
133
133
|
},
|
|
134
|
-
"./components/badge": {
|
|
135
|
-
"types": "./dist/components/badge.d.ts",
|
|
136
|
-
"default": "./dist/components/badge.js"
|
|
137
|
-
},
|
|
138
|
-
"./components/button": {
|
|
139
|
-
"types": "./dist/components/button.d.ts",
|
|
140
|
-
"default": "./dist/components/button.js"
|
|
141
|
-
},
|
|
142
|
-
"./components/button-group": {
|
|
143
|
-
"types": "./dist/components/button-group.d.ts",
|
|
144
|
-
"default": "./dist/components/button-group.js"
|
|
145
|
-
},
|
|
146
134
|
"./components/callout": {
|
|
147
135
|
"types": "./dist/components/callout.d.ts",
|
|
148
136
|
"default": "./dist/components/callout.js"
|
|
149
137
|
},
|
|
150
|
-
"./components/card": {
|
|
151
|
-
"types": "./dist/components/card.d.ts",
|
|
152
|
-
"default": "./dist/components/card.js"
|
|
153
|
-
},
|
|
154
138
|
"./components/code-block": {
|
|
155
139
|
"types": "./dist/components/code-block.d.ts",
|
|
156
140
|
"default": "./dist/components/code-block.js"
|
|
@@ -171,34 +155,10 @@
|
|
|
171
155
|
"types": "./dist/components/copy-prompt.d.ts",
|
|
172
156
|
"default": "./dist/components/copy-prompt.js"
|
|
173
157
|
},
|
|
174
|
-
"./components/dialog": {
|
|
175
|
-
"types": "./dist/components/dialog.d.ts",
|
|
176
|
-
"default": "./dist/components/dialog.js"
|
|
177
|
-
},
|
|
178
|
-
"./components/drawer": {
|
|
179
|
-
"types": "./dist/components/drawer.d.ts",
|
|
180
|
-
"default": "./dist/components/drawer.js"
|
|
181
|
-
},
|
|
182
158
|
"./components/dropdown-menu": {
|
|
183
159
|
"types": "./dist/components/dropdown-menu.d.ts",
|
|
184
160
|
"default": "./dist/components/dropdown-menu.js"
|
|
185
161
|
},
|
|
186
|
-
"./components/input": {
|
|
187
|
-
"types": "./dist/components/input.d.ts",
|
|
188
|
-
"default": "./dist/components/input.js"
|
|
189
|
-
},
|
|
190
|
-
"./components/input-group": {
|
|
191
|
-
"types": "./dist/components/input-group.d.ts",
|
|
192
|
-
"default": "./dist/components/input-group.js"
|
|
193
|
-
},
|
|
194
|
-
"./components/kbd": {
|
|
195
|
-
"types": "./dist/components/kbd.d.ts",
|
|
196
|
-
"default": "./dist/components/kbd.js"
|
|
197
|
-
},
|
|
198
|
-
"./components/theme-aware-image": {
|
|
199
|
-
"types": "./dist/components/theme-aware-image.d.ts",
|
|
200
|
-
"default": "./dist/components/theme-aware-image.js"
|
|
201
|
-
},
|
|
202
162
|
"./components/mermaid": {
|
|
203
163
|
"types": "./dist/components/mermaid.d.ts",
|
|
204
164
|
"default": "./dist/components/mermaid.js"
|
|
@@ -215,74 +175,30 @@
|
|
|
215
175
|
"types": "./dist/components/scroll-area.d.ts",
|
|
216
176
|
"default": "./dist/components/scroll-area.js"
|
|
217
177
|
},
|
|
218
|
-
"./components/separator": {
|
|
219
|
-
"types": "./dist/components/separator.d.ts",
|
|
220
|
-
"default": "./dist/components/separator.js"
|
|
221
|
-
},
|
|
222
|
-
"./components/sheet": {
|
|
223
|
-
"types": "./dist/components/sheet.d.ts",
|
|
224
|
-
"default": "./dist/components/sheet.js"
|
|
225
|
-
},
|
|
226
|
-
"./components/sonner": {
|
|
227
|
-
"types": "./dist/components/sonner.d.ts",
|
|
228
|
-
"default": "./dist/components/sonner.js"
|
|
229
|
-
},
|
|
230
|
-
"./components/spinner": {
|
|
231
|
-
"types": "./dist/components/spinner.d.ts",
|
|
232
|
-
"default": "./dist/components/spinner.js"
|
|
233
|
-
},
|
|
234
|
-
"./components/switch": {
|
|
235
|
-
"types": "./dist/components/switch.d.ts",
|
|
236
|
-
"default": "./dist/components/switch.js"
|
|
237
|
-
},
|
|
238
|
-
"./components/theme-switcher": {
|
|
239
|
-
"types": "./dist/components/theme-switcher.d.ts",
|
|
240
|
-
"default": "./dist/components/theme-switcher.js"
|
|
241
|
-
},
|
|
242
|
-
"./components/textarea": {
|
|
243
|
-
"types": "./dist/components/textarea.d.ts",
|
|
244
|
-
"default": "./dist/components/textarea.js"
|
|
245
|
-
},
|
|
246
|
-
"./components/tooltip": {
|
|
247
|
-
"types": "./dist/components/tooltip.d.ts",
|
|
248
|
-
"default": "./dist/components/tooltip.js"
|
|
249
|
-
},
|
|
250
178
|
"./components/video": {
|
|
251
179
|
"types": "./dist/components/video.d.ts",
|
|
252
180
|
"default": "./dist/components/video.js"
|
|
253
181
|
},
|
|
254
|
-
"./assets/icons": {
|
|
255
|
-
"types": "./dist/assets/icons/index.d.ts",
|
|
256
|
-
"default": "./dist/assets/icons/index.js"
|
|
257
|
-
},
|
|
258
|
-
"./assets/icons/*": {
|
|
259
|
-
"types": "./dist/assets/icons/*.d.ts",
|
|
260
|
-
"default": "./dist/assets/icons/*.js"
|
|
261
|
-
},
|
|
262
|
-
"./assets/logos": {
|
|
263
|
-
"types": "./dist/assets/logos/index.d.ts",
|
|
264
|
-
"default": "./dist/assets/logos/index.js"
|
|
265
|
-
},
|
|
266
|
-
"./assets/logos/*": {
|
|
267
|
-
"types": "./dist/assets/logos/*.d.ts",
|
|
268
|
-
"default": "./dist/assets/logos/*.js"
|
|
269
|
-
},
|
|
270
182
|
"./styles.css": "./styles.css",
|
|
271
183
|
"./theme.css": "./theme.css",
|
|
272
184
|
"./package.json": "./package.json"
|
|
273
185
|
},
|
|
186
|
+
"scripts": {
|
|
187
|
+
"build": "rm -rf dist docs template && node ./scripts/bundle-template.mjs && node ./scripts/bundle-docs.mjs && tsc -p tsconfig.runtime.json && tsup --config tsup.config.cli.ts",
|
|
188
|
+
"dev": "tsc -p tsconfig.runtime.json --watch --preserveWatchOutput"
|
|
189
|
+
},
|
|
274
190
|
"dependencies": {
|
|
275
191
|
"@ai-sdk/react": "^3.0.134",
|
|
276
192
|
"@clack/prompts": "^0.11.0",
|
|
277
|
-
"@icons-pack/react-simple-icons": "^13.8.0",
|
|
278
193
|
"@orama/tokenizers": "^3.1.16",
|
|
279
194
|
"@streamdown/cjk": "^1.0.1",
|
|
280
195
|
"@streamdown/code": "^1.0.1",
|
|
281
196
|
"@vercel/agent-readability": "^0.6.0",
|
|
197
|
+
"@vercel/geistcn": "1.0.3",
|
|
198
|
+
"@vercel/geistcn-assets": "2.0.1",
|
|
282
199
|
"@vercel/oidc": "^3.4.1",
|
|
283
200
|
"ai": "^6.0.132",
|
|
284
201
|
"class-variance-authority": "^0.7.1",
|
|
285
|
-
"clsx": "^2.1.1",
|
|
286
202
|
"commander": "^14.0.2",
|
|
287
203
|
"dexie": "^4.2.1",
|
|
288
204
|
"dexie-react-hooks": "^4.2.0",
|
|
@@ -290,7 +206,6 @@
|
|
|
290
206
|
"fumadocs-mdx": "14.0.4",
|
|
291
207
|
"fumadocs-ui": "16.2.2",
|
|
292
208
|
"glob": "^11.0.0",
|
|
293
|
-
"lucide-react": "^0.555.0",
|
|
294
209
|
"mermaid": "^11.12.2",
|
|
295
210
|
"motion": "^12.23.25",
|
|
296
211
|
"next-themes": "^0.4.6",
|
|
@@ -300,19 +215,16 @@
|
|
|
300
215
|
"remark-gfm": "^4.0.1",
|
|
301
216
|
"remark-mdx": "^3.1.1",
|
|
302
217
|
"remark-parse": "^11.0.0",
|
|
303
|
-
"sonner": "^2.0.7",
|
|
304
218
|
"streamdown": "^2.1.0",
|
|
305
|
-
"tailwind-merge": "^3.4.0",
|
|
306
219
|
"ts-morph": "^27.0.2",
|
|
307
220
|
"tw-animate-css": "^1.4.0",
|
|
308
221
|
"unified": "^11.0.5",
|
|
309
222
|
"unist-util-visit": "^5.1.0",
|
|
310
223
|
"use-stick-to-bottom": "^1.1.1",
|
|
311
|
-
"vaul": "^1.1.2",
|
|
312
224
|
"zod": "^4.1.13"
|
|
313
225
|
},
|
|
314
226
|
"peerDependencies": {
|
|
315
|
-
"next": "^16.3.
|
|
227
|
+
"next": "^16.3.3",
|
|
316
228
|
"react": "^19.2.3",
|
|
317
229
|
"react-dom": "^19.2.3",
|
|
318
230
|
"tailwindcss": "^4.1.17"
|
|
@@ -326,14 +238,10 @@
|
|
|
326
238
|
"@types/react": "^19.2.7",
|
|
327
239
|
"@types/react-dom": "^19.2.3",
|
|
328
240
|
"mdast-util-mdx-jsx": "^3.2.0",
|
|
329
|
-
"next": "16.3.
|
|
241
|
+
"next": "16.3.3",
|
|
330
242
|
"react": "^19.2.3",
|
|
331
243
|
"react-dom": "^19.2.3",
|
|
332
244
|
"tsup": "^8.5.1",
|
|
333
245
|
"typescript": "^5.9.3"
|
|
334
|
-
},
|
|
335
|
-
"scripts": {
|
|
336
|
-
"build": "rm -rf dist docs template && node ./scripts/bundle-template.mjs && node ./scripts/bundle-docs.mjs && tsc -p tsconfig.runtime.json && tsup --config tsup.config.cli.ts",
|
|
337
|
-
"dev": "tsc -p tsconfig.runtime.json --watch --preserveWatchOutput"
|
|
338
246
|
}
|
|
339
|
-
}
|
|
247
|
+
}
|
package/styles.css
CHANGED
|
@@ -1,9 +1,10 @@
|
|
|
1
|
-
@import "
|
|
1
|
+
@import "@vercel/geistcn/tailwind.css";
|
|
2
2
|
@import "fumadocs-ui/css/shadcn.css";
|
|
3
3
|
@import "fumadocs-ui/css/preset.css";
|
|
4
|
-
@import "tw-animate-css";
|
|
5
4
|
|
|
6
5
|
/* The Geist design layer (theme tokens, utilities, base, fumadocs theming).
|
|
7
6
|
Kept in a separate, import-free file so consuming apps can pull in the same
|
|
8
7
|
design system without re-bundling Tailwind and the fumadocs presets. */
|
|
9
8
|
@import "./theme.css";
|
|
9
|
+
@import "@vercel/geistcn/styles.css";
|
|
10
|
+
@import "@vercel/geistcn/marketing-typography.css";
|
package/template/AGENTS.md
CHANGED
|
@@ -109,3 +109,13 @@ Use these instructions when an AI coding agent edits this project.
|
|
|
109
109
|
- Run `pnpm dev` and open the changed pages when visual layout, navigation, or MDX rendering changes.
|
|
110
110
|
- Check both `/docs` and AI-readable routes such as `/agents.md`, `/.well-known/mcp.json`, `/llms.txt`, or a page-level `.md` URL when changing content routing or proxy behavior.
|
|
111
111
|
- Confirm no secrets were added to source files. Use `.env.local` for local values and keep it out of Git.
|
|
112
|
+
|
|
113
|
+
<!-- BEGIN:nextjs-agent-rules -->
|
|
114
|
+
|
|
115
|
+
# This is NOT the Next.js you know
|
|
116
|
+
|
|
117
|
+
This version has breaking changes — APIs, conventions, and file structure may all differ from your training data. Read the relevant guide in `node_modules/next/dist/docs/` (resolved from this file's directory; in monorepos the `next` package may not be visible from the repo root) before writing any code. Heed deprecation notices.
|
|
118
|
+
|
|
119
|
+
This block is written and re-added by `next dev` — verify at `node_modules/next/dist/server/lib/generate-agent-files.js`. Removing it from a diff only re-creates the uncommitted change; committing it with your work keeps the tree clean.
|
|
120
|
+
|
|
121
|
+
<!-- END:nextjs-agent-rules -->
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Badge } from "@vercel/
|
|
1
|
+
import { Badge } from "@vercel/geistcn/components/badge";
|
|
2
2
|
import type { ReactNode } from "react";
|
|
3
3
|
|
|
4
4
|
interface HeroProps {
|
|
@@ -11,7 +11,7 @@ interface HeroProps {
|
|
|
11
11
|
export const Hero = ({ badge, title, description, children }: HeroProps) => (
|
|
12
12
|
<section className="mt-(--fd-nav-height) space-y-6 px-4 @min-[640px]:pt-24 pt-16 pb-16 text-center">
|
|
13
13
|
<div className="mx-auto w-full max-w-4xl space-y-5">
|
|
14
|
-
<Badge className="rounded-full" variant="
|
|
14
|
+
<Badge className="rounded-full" contrast="low" variant="gray">
|
|
15
15
|
<div className="size-2 rounded-full bg-gray-800" />
|
|
16
16
|
<p>{badge}</p>
|
|
17
17
|
</Badge>
|
|
@@ -1,17 +1,25 @@
|
|
|
1
|
+
import { cn } from "@vercel/geistcn/utils";
|
|
1
2
|
import type { ReactNode } from "react";
|
|
2
3
|
|
|
3
4
|
interface OneTwoSectionProps {
|
|
4
5
|
children?: ReactNode;
|
|
6
|
+
className?: string;
|
|
5
7
|
description: string;
|
|
6
8
|
title: string;
|
|
7
9
|
}
|
|
8
10
|
|
|
9
11
|
export const OneTwoSection = ({
|
|
12
|
+
className,
|
|
10
13
|
title,
|
|
11
14
|
description,
|
|
12
15
|
children,
|
|
13
16
|
}: OneTwoSectionProps) => (
|
|
14
|
-
<div
|
|
17
|
+
<div
|
|
18
|
+
className={cn(
|
|
19
|
+
"grid @min-[640px]:grid-cols-3 @min-[640px]:gap-0 gap-12 @min-[640px]:py-12 py-8",
|
|
20
|
+
className
|
|
21
|
+
)}
|
|
22
|
+
>
|
|
15
23
|
<div className="flex flex-col gap-2 text-balance">
|
|
16
24
|
<h2 className="font-[450]! @min-[640px]:text-2xl @min-[768px]:text-3xl text-gray-1000 text-xl tracking-tighter">
|
|
17
25
|
{title}
|
|
@@ -24,7 +24,7 @@ export const TextGridSection = ({
|
|
|
24
24
|
)}
|
|
25
25
|
>
|
|
26
26
|
{title || description ? (
|
|
27
|
-
<div className="grid
|
|
27
|
+
<div className="grid @min-[768px]:grid-cols-2 @min-[768px]:items-start @min-[768px]:gap-8 gap-4 text-balance">
|
|
28
28
|
{title ? (
|
|
29
29
|
<h2 className="font-[450]! @min-[1024px]:text-[40px] @min-[640px]:text-2xl @min-[768px]:text-3xl text-gray-1000 text-xl tracking-tighter">
|
|
30
30
|
{title}
|
|
@@ -13,7 +13,6 @@ import type { GeistdocsAgentReadinessConfig } from "@vercel/geistdocs/config";
|
|
|
13
13
|
import type { Metadata } from "next";
|
|
14
14
|
import { config } from "@/lib/geistdocs/config";
|
|
15
15
|
import { getLocalizedPath } from "@/lib/geistdocs/public-path";
|
|
16
|
-
import { CenteredSection } from "./components/centered-section";
|
|
17
16
|
import { CTA } from "./components/cta";
|
|
18
17
|
import { Hero } from "./components/hero";
|
|
19
18
|
import { OneTwoSection } from "./components/one-two-section";
|
|
@@ -132,22 +131,22 @@ const HomePage = async ({ params }: PageProps<"/[lang]">) => {
|
|
|
132
131
|
description="Geistdocs combines a shared runtime with local ownership, so documentation teams can standardize behavior without centralizing every page."
|
|
133
132
|
title="A complete foundation for product documentation"
|
|
134
133
|
/>
|
|
135
|
-
<
|
|
136
|
-
|
|
134
|
+
<OneTwoSection
|
|
135
|
+
className="@min-[640px]:mt-16 mt-12"
|
|
137
136
|
description="Every generated project starts as a normal Next.js application. Write MDX locally, configure the shared shell, and deploy with the same workflow as the product it documents."
|
|
138
137
|
title="Keep documentation close to the product"
|
|
139
138
|
>
|
|
140
|
-
<div className="grid gap-3 rounded-lg border bg-background-100 p-6 font-mono text-sm">
|
|
139
|
+
<div className="grid w-full max-w-3xl gap-3 justify-self-end rounded-lg border bg-background-100 p-6 font-mono text-sm">
|
|
141
140
|
<p>content/docs/ stores the documentation source.</p>
|
|
142
141
|
<p>geistdocs.tsx defines product and agent metadata.</p>
|
|
143
142
|
<p>@vercel/geistdocs provides the shared runtime.</p>
|
|
144
143
|
</div>
|
|
145
|
-
</
|
|
144
|
+
</OneTwoSection>
|
|
146
145
|
<OneTwoSection
|
|
147
146
|
description="Agents can discover the documentation corpus, choose a focused page, and recover from stale links without parsing the interactive application shell."
|
|
148
147
|
title="Give agents a direct path through the docs"
|
|
149
148
|
>
|
|
150
|
-
<ul className="grid gap-4 rounded-lg border bg-background-100 p-6 text-gray-900">
|
|
149
|
+
<ul className="grid w-full max-w-3xl gap-4 justify-self-end rounded-lg border bg-background-100 p-6 text-gray-900">
|
|
151
150
|
<li>
|
|
152
151
|
<a
|
|
153
152
|
className="underline"
|
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
import "../global.css";
|
|
2
|
+
import { geistFontClasses } from "@vercel/geistcn/core";
|
|
3
|
+
import { cn } from "@vercel/geistcn/utils";
|
|
2
4
|
import "@/lib/geistdocs/site-url-warning";
|
|
3
5
|
import { Footer } from "@vercel/geistdocs/footer";
|
|
4
6
|
import { Navbar } from "@vercel/geistdocs/navbar";
|
|
5
7
|
import type { Metadata } from "next";
|
|
6
8
|
import { GeistdocsProvider } from "@/components/geistdocs/provider";
|
|
7
9
|
import { config } from "@/lib/geistdocs/config";
|
|
8
|
-
import { mono, sans } from "@/lib/geistdocs/fonts";
|
|
9
10
|
import { i18n } from "@/lib/geistdocs/i18n";
|
|
10
11
|
import { getRootLang } from "@/lib/geistdocs/root-params";
|
|
11
12
|
import { isSiteUrlConfigured, siteUrl } from "@/lib/geistdocs/site-url";
|
|
12
|
-
import { cn } from "@/lib/utils";
|
|
13
13
|
|
|
14
14
|
export const generateStaticParams = () =>
|
|
15
15
|
i18n.languages.map((lang) => ({ lang }));
|
|
@@ -23,11 +23,14 @@ const Layout = async ({ children }: LayoutProps<"/[lang]">) => {
|
|
|
23
23
|
|
|
24
24
|
return (
|
|
25
25
|
<html
|
|
26
|
-
className={cn(
|
|
26
|
+
className={cn(
|
|
27
|
+
geistFontClasses,
|
|
28
|
+
"tailwind tailwind-preflight antialiased"
|
|
29
|
+
)}
|
|
27
30
|
lang={lang}
|
|
28
31
|
suppressHydrationWarning
|
|
29
32
|
>
|
|
30
|
-
<body>
|
|
33
|
+
<body style={{ backgroundColor: "var(--ds-background-200)" }}>
|
|
31
34
|
<GeistdocsProvider basePath={config.basePath} lang={lang}>
|
|
32
35
|
<Navbar config={config} />
|
|
33
36
|
{children}
|
|
@@ -1,25 +1,28 @@
|
|
|
1
|
-
@import "
|
|
1
|
+
@import "@vercel/geistcn/tailwind.css";
|
|
2
2
|
@import "fumadocs-ui/css/shadcn.css";
|
|
3
3
|
@import "fumadocs-ui/css/preset.css";
|
|
4
|
-
@import "tw-animate-css";
|
|
5
|
-
|
|
6
|
-
/* Geist design layer from the package. theme.css already @sources the package
|
|
7
|
-
dist and streamdown, so don't re-@source those here; only @source your own
|
|
8
|
-
files if Tailwind misses them. Keep app-only deltas below. */
|
|
9
4
|
@import "@vercel/geistdocs/theme.css";
|
|
5
|
+
@import "@vercel/geistcn/styles.css";
|
|
6
|
+
@import "@vercel/geistcn/marketing-typography.css";
|
|
7
|
+
|
|
8
|
+
/* GeistCN components are authored with Tailwind utilities. Scan only component
|
|
9
|
+
source: scanning the package root also includes font-pixel internals whose
|
|
10
|
+
published paths point outside the app and make Turbopack panic. */
|
|
11
|
+
@source "../../node_modules/@vercel/geistcn/src/components/**/*.{ts,tsx}";
|
|
12
|
+
|
|
13
|
+
:root {
|
|
14
|
+
--font-sans: var(--font-geist-sans);
|
|
15
|
+
font-feature-settings:
|
|
16
|
+
"rlig" 1,
|
|
17
|
+
"calt" 0,
|
|
18
|
+
"ss11" 1;
|
|
19
|
+
}
|
|
10
20
|
|
|
11
21
|
/* App-only override: this template uses the 200 surface as the page
|
|
12
22
|
background (the package defaults to background-100). */
|
|
13
23
|
@layer base {
|
|
14
24
|
body {
|
|
15
|
-
@apply
|
|
16
|
-
}
|
|
17
|
-
|
|
18
|
-
/* Geist Sans is loaded from the `geist` npm package, which exposes the
|
|
19
|
-
`--font-geist-sans` variable. Alias it so `font-sans`/`--font-sans`
|
|
20
|
-
resolves to it. */
|
|
21
|
-
:root {
|
|
22
|
-
--font-sans: var(--font-geist-sans);
|
|
25
|
+
@apply text-gray-1000;
|
|
23
26
|
}
|
|
24
27
|
}
|
|
25
28
|
|
|
@@ -31,11 +31,11 @@ related:
|
|
|
31
31
|
项目根目录下的 `geistdocs.tsx` 文件包含主要自定义选项:
|
|
32
32
|
|
|
33
33
|
```tsx title="geistdocs.tsx"
|
|
34
|
-
import {
|
|
34
|
+
import { IconBookOpen } from "@vercel/geistcn-assets/icons";
|
|
35
35
|
|
|
36
36
|
export const Logo = () => (
|
|
37
37
|
<div className="flex items-center gap-2">
|
|
38
|
-
<
|
|
38
|
+
<IconBookOpen className="size-5" />
|
|
39
39
|
<p className="font-semibold text-xl tracking-tight">Geistdocs</p>
|
|
40
40
|
</div>
|
|
41
41
|
);
|
|
@@ -42,7 +42,7 @@ Fix unrelated build failures first. A migration is safer when the starting point
|
|
|
42
42
|
|
|
43
43
|
## Install Geistdocs
|
|
44
44
|
|
|
45
|
-
Add `@vercel/geistdocs` and align the supported Fumadocs and Next.js dependencies for the package version you are adopting.
|
|
45
|
+
Add `@vercel/geistdocs` and align the supported Fumadocs and Next.js dependencies for the package version you are adopting. Geistdocs requires Next.js 16.3.3 or later within 16.x. Earlier 16.3 releases can retain an optional catch-all route's index content after a client navigation to a child page when Cache Components and Partial Prefetching are enabled.
|
|
46
46
|
|
|
47
47
|
For an existing project, use your package manager directly:
|
|
48
48
|
|
|
@@ -375,16 +375,14 @@ For a base-path application whose root page is documentation, add `"/"` to the s
|
|
|
375
375
|
Tailwind CSS v4 requires `@source` entries for package components and related dependencies.
|
|
376
376
|
|
|
377
377
|
```css title="app/styles/geistdocs.css"
|
|
378
|
-
@import "
|
|
378
|
+
@import "@vercel/geistcn/tailwind.css";
|
|
379
|
+
@import "@vercel/geistcn/styles.css";
|
|
379
380
|
@import "fumadocs-ui/css/shadcn.css";
|
|
380
381
|
@import "fumadocs-ui/css/preset.css";
|
|
381
|
-
@import "
|
|
382
|
-
|
|
383
|
-
@source "../../node_modules/@vercel/geistdocs/dist/**/*.js";
|
|
384
|
-
@source "../../node_modules/streamdown/dist/*.js";
|
|
382
|
+
@import "@vercel/geistdocs/theme.css";
|
|
385
383
|
```
|
|
386
384
|
|
|
387
|
-
|
|
385
|
+
Geistcn owns the Geist tokens, theme, typography, preflight, and animation utilities. The Geistdocs theme entry point remains during the compatibility migration for documentation and Fumadocs integration rules and to source the compiled runtime dependencies.
|
|
388
386
|
|
|
389
387
|
## Handle environment variables
|
|
390
388
|
|
|
@@ -12,7 +12,9 @@ related:
|
|
|
12
12
|
Geistdocs supports MDX, a superset of Markdown that allows you to use JSX components within your documentation. This guide covers all the formatting options available.
|
|
13
13
|
|
|
14
14
|
<CopyPrompt text="Help me write a Geistdocs MDX page. Use this page as a syntax reference and create an example page with frontmatter, headings, links, a code block, a Callout, and a CopyPrompt component.">
|
|
15
|
-
Help me write a Geistdocs MDX page. Use this page as a syntax reference and
|
|
15
|
+
Help me write a Geistdocs MDX page. Use this page as a syntax reference and
|
|
16
|
+
create an example page with frontmatter, headings, links, a code block, a
|
|
17
|
+
`Callout`, and a `CopyPrompt` component.
|
|
16
18
|
</CopyPrompt>
|
|
17
19
|
|
|
18
20
|
## Frontmatter
|
|
@@ -194,6 +196,78 @@ export const Button = ({ children }) => {
|
|
|
194
196
|
};
|
|
195
197
|
```
|
|
196
198
|
|
|
199
|
+
### Tabs and switchers
|
|
200
|
+
|
|
201
|
+
Use consecutive fences with `tab` metadata for code tabs that expose every
|
|
202
|
+
option at once:
|
|
203
|
+
|
|
204
|
+
````md
|
|
205
|
+
```ts tab="TypeScript" title="example.ts"
|
|
206
|
+
export const greeting: string = "Hello from TypeScript";
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
```js tab="JavaScript" title="example.js"
|
|
210
|
+
export const greeting = "Hello from JavaScript";
|
|
211
|
+
```
|
|
212
|
+
````
|
|
213
|
+
|
|
214
|
+
This renders as:
|
|
215
|
+
|
|
216
|
+
```ts tab="TypeScript" title="example.ts"
|
|
217
|
+
export const greeting: string = "Hello from TypeScript";
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
```js tab="JavaScript" title="example.js"
|
|
221
|
+
export const greeting = "Hello from JavaScript";
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
Wrap the same fences in `<CodeBlockTabs compact>` to move the selector into the
|
|
225
|
+
code-block header:
|
|
226
|
+
|
|
227
|
+
````mdx
|
|
228
|
+
<CompactCodeBlockTabs defaultValue="TypeScript">
|
|
229
|
+
<CodeBlockTabsList>
|
|
230
|
+
<CodeBlockTabsTrigger value="TypeScript">TypeScript</CodeBlockTabsTrigger>
|
|
231
|
+
<CodeBlockTabsTrigger value="JavaScript">JavaScript</CodeBlockTabsTrigger>
|
|
232
|
+
</CodeBlockTabsList>
|
|
233
|
+
<CodeBlockTab value="TypeScript">
|
|
234
|
+
```ts title="example.ts"
|
|
235
|
+
export const greeting: string = "Hello from TypeScript";
|
|
236
|
+
```
|
|
237
|
+
</CodeBlockTab>
|
|
238
|
+
<CodeBlockTab value="JavaScript">
|
|
239
|
+
```js title="example.js"
|
|
240
|
+
export const greeting = "Hello from JavaScript";
|
|
241
|
+
```
|
|
242
|
+
</CodeBlockTab>
|
|
243
|
+
</CompactCodeBlockTabs>
|
|
244
|
+
````
|
|
245
|
+
|
|
246
|
+
This renders as:
|
|
247
|
+
|
|
248
|
+
<CompactCodeBlockTabs defaultValue="TypeScript">
|
|
249
|
+
<CodeBlockTabsList>
|
|
250
|
+
<CodeBlockTabsTrigger value="TypeScript">TypeScript</CodeBlockTabsTrigger>
|
|
251
|
+
<CodeBlockTabsTrigger value="JavaScript">JavaScript</CodeBlockTabsTrigger>
|
|
252
|
+
</CodeBlockTabsList>
|
|
253
|
+
<CodeBlockTab value="TypeScript">
|
|
254
|
+
```ts title="example.ts"
|
|
255
|
+
export const greeting: string = "Hello from TypeScript";
|
|
256
|
+
```
|
|
257
|
+
</CodeBlockTab>
|
|
258
|
+
<CodeBlockTab value="JavaScript">
|
|
259
|
+
```js title="example.js"
|
|
260
|
+
export const greeting = "Hello from JavaScript";
|
|
261
|
+
```
|
|
262
|
+
</CodeBlockTab>
|
|
263
|
+
</CompactCodeBlockTabs>
|
|
264
|
+
|
|
265
|
+
When migrating an existing site such as next-site, translate adjacent
|
|
266
|
+
`switcher` fences to `tab="TypeScript"` and `tab="JavaScript"`, then wrap the
|
|
267
|
+
pair with `<CodeBlockTabs compact>`. Import `@vercel/geistdocs/styles.css` (or
|
|
268
|
+
`theme.css` with the documented Geist dependencies) so Tailwind scans the
|
|
269
|
+
package's compiled components and emits the tab layout utilities.
|
|
270
|
+
|
|
197
271
|
### Framework icons
|
|
198
272
|
|
|
199
273
|
Append `#<framework>` to the title to show a framework logo instead of the
|
|
@@ -202,22 +276,22 @@ values are `#next` / `#nextjs` and `#svelte` / `#sveltekit`:
|
|
|
202
276
|
|
|
203
277
|
````md
|
|
204
278
|
```ts title="flags.ts#next"
|
|
205
|
-
import { flag } from
|
|
279
|
+
import { flag } from "flags/next";
|
|
206
280
|
```
|
|
207
281
|
|
|
208
282
|
```ts title="flags.ts#svelte"
|
|
209
|
-
import { flag } from
|
|
283
|
+
import { flag } from "flags/sveltekit";
|
|
210
284
|
```
|
|
211
285
|
````
|
|
212
286
|
|
|
213
287
|
This renders as:
|
|
214
288
|
|
|
215
289
|
```ts title="flags.ts#next"
|
|
216
|
-
import { flag } from
|
|
290
|
+
import { flag } from "flags/next";
|
|
217
291
|
```
|
|
218
292
|
|
|
219
293
|
```ts title="flags.ts#svelte"
|
|
220
|
-
import { flag } from
|
|
294
|
+
import { flag } from "flags/sveltekit";
|
|
221
295
|
```
|
|
222
296
|
|
|
223
297
|
### Line Numbers
|
|
@@ -179,7 +179,7 @@ Each version can define an `icon` to override the default current/previous versi
|
|
|
179
179
|
Use `GeistdocsRouteSelect` for framework, product, or route switchers that should not use version-specific labels:
|
|
180
180
|
|
|
181
181
|
```tsx
|
|
182
|
-
import {
|
|
182
|
+
import { LogoIconNextSvg, LogoSvelte } from "@vercel/geistcn-assets/logos";
|
|
183
183
|
import { GeistdocsRouteSelect } from "@vercel/geistdocs/versions";
|
|
184
184
|
|
|
185
185
|
<GeistdocsRouteSelect
|
|
@@ -190,14 +190,14 @@ import { GeistdocsRouteSelect } from "@vercel/geistdocs/versions";
|
|
|
190
190
|
id: "nextjs",
|
|
191
191
|
label: "Next.js",
|
|
192
192
|
description: "React framework",
|
|
193
|
-
icon: <
|
|
193
|
+
icon: <LogoIconNextSvg size={18} />,
|
|
194
194
|
href: "/:path*",
|
|
195
195
|
},
|
|
196
196
|
{
|
|
197
197
|
id: "sveltekit",
|
|
198
198
|
label: "SvelteKit",
|
|
199
199
|
description: "Svelte framework",
|
|
200
|
-
icon: <
|
|
200
|
+
icon: <LogoSvelte height={18} />,
|
|
201
201
|
routePrefix: "/sveltekit",
|
|
202
202
|
href: "/sveltekit/:path*",
|
|
203
203
|
},
|