@vercel/geistdocs 1.24.1 → 1.25.1-canary.47f1ad5
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/blockquote.d.ts +3 -0
- package/dist/components/blockquote.d.ts.map +1 -0
- package/dist/components/blockquote.js +3 -0
- package/dist/components/callout.d.ts +13 -10
- package/dist/components/callout.d.ts.map +1 -1
- package/dist/components/callout.js +7 -7
- 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 +30 -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 +18 -25
- package/dist/components/copy-prompt.d.ts +2 -1
- package/dist/components/copy-prompt.d.ts.map +1 -1
- package/dist/components/copy-prompt.js +5 -5
- package/dist/components/heading.d.ts +7 -0
- package/dist/components/heading.d.ts.map +1 -0
- package/dist/components/heading.js +14 -0
- package/dist/components/mermaid.js +1 -1
- package/dist/components/table.d.ts +3 -0
- package/dist/components/table.d.ts.map +1 -0
- package/dist/components/table.js +3 -0
- 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/app-route-manifest.d.ts +19 -0
- package/dist/internal/app-route-manifest.d.ts.map +1 -0
- package/dist/internal/app-route-manifest.js +121 -0
- package/dist/internal/app-route-scanner.d.ts +9 -0
- package/dist/internal/app-route-scanner.d.ts.map +1 -0
- package/dist/internal/app-route-scanner.js +149 -0
- 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 +21 -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 +28 -20
- 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 +11 -16
- 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 +49 -29
- 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-responsive.d.ts +0 -1
- package/dist/internal/sidebar-responsive.d.ts.map +1 -1
- package/dist/internal/sidebar-responsive.js +0 -9
- 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 +66 -40
- package/dist/internal/table-of-contents.d.ts.map +1 -1
- package/dist/internal/table-of-contents.js +1 -1
- package/dist/internal/toc-items.d.ts.map +1 -1
- package/dist/internal/toc-items.js +17 -7
- package/dist/internal/ui/dropdown-menu.d.ts.map +1 -1
- package/dist/internal/ui/dropdown-menu.js +8 -8
- package/dist/internal/ui/navigation-menu.d.ts.map +1 -1
- package/dist/internal/ui/navigation-menu.js +4 -4
- 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/internal/use-mobile.d.ts.map +1 -1
- package/dist/internal/use-mobile.js +2 -12
- package/dist/layout.d.ts +1 -0
- package/dist/layout.d.ts.map +1 -1
- package/dist/layout.js +3 -1
- package/dist/mdx.d.ts.map +1 -1
- package/dist/mdx.js +18 -3
- 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/next.d.ts +6 -0
- package/dist/next.d.ts.map +1 -0
- package/dist/next.js +52 -0
- package/dist/pages/docs.d.ts.map +1 -1
- package/dist/pages/docs.js +8 -3
- package/dist/proxy.d.ts +2 -1
- package/dist/proxy.d.ts.map +1 -1
- package/dist/proxy.js +28 -5
- package/dist/routes/llms.d.ts +1 -1
- package/dist/routes/llms.d.ts.map +1 -1
- package/dist/routes/llms.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 +2 -3
- package/docs/llms.txt +231 -98
- package/docs/manifest.json +2 -11
- package/docs/pages/configuration.md +8 -0
- package/docs/pages/md.md +8 -5
- package/docs/pages/migration.md +12 -12
- package/docs/pages/proxy.md +20 -1
- package/docs/pages/syntax.md +178 -11
- package/docs/pages/versioned-docs.md +3 -3
- package/docs/sitemap.md +1 -2
- package/package.json +15 -102
- package/styles.css +3 -2
- package/template/AGENTS.md +12 -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 +11 -4
- package/template/app/[lang]/llms.mdx/[[...slug]]/route.ts +0 -1
- package/template/app/styles/geistdocs.css +18 -15
- package/template/components/ui/button.tsx +1 -1
- package/template/content/docs/configuration.cn.mdx +2 -2
- package/template/content/docs/configuration.mdx +8 -0
- package/template/content/docs/md.mdx +8 -5
- package/template/content/docs/migration.mdx +12 -12
- package/template/content/docs/proxy.mdx +20 -1
- package/template/content/docs/syntax.mdx +183 -11
- package/template/content/docs/versioned-docs.mdx +3 -3
- package/template/lib/geistdocs/config.tsx +0 -5
- package/template/next.config.ts +19 -5
- package/template/package.json +5 -7
- package/theme.css +39 -695
- 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
|
@@ -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,16 @@
|
|
|
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";
|
|
6
|
+
import { GeistdocsThemeScript } from "@vercel/geistdocs/layout";
|
|
4
7
|
import { Navbar } from "@vercel/geistdocs/navbar";
|
|
5
8
|
import type { Metadata } from "next";
|
|
6
9
|
import { GeistdocsProvider } from "@/components/geistdocs/provider";
|
|
7
10
|
import { config } from "@/lib/geistdocs/config";
|
|
8
|
-
import { mono, sans } from "@/lib/geistdocs/fonts";
|
|
9
11
|
import { i18n } from "@/lib/geistdocs/i18n";
|
|
10
12
|
import { getRootLang } from "@/lib/geistdocs/root-params";
|
|
11
13
|
import { isSiteUrlConfigured, siteUrl } from "@/lib/geistdocs/site-url";
|
|
12
|
-
import { cn } from "@/lib/utils";
|
|
13
14
|
|
|
14
15
|
export const generateStaticParams = () =>
|
|
15
16
|
i18n.languages.map((lang) => ({ lang }));
|
|
@@ -23,11 +24,17 @@ const Layout = async ({ children }: LayoutProps<"/[lang]">) => {
|
|
|
23
24
|
|
|
24
25
|
return (
|
|
25
26
|
<html
|
|
26
|
-
className={cn(
|
|
27
|
+
className={cn(
|
|
28
|
+
geistFontClasses,
|
|
29
|
+
"tailwind tailwind-preflight antialiased"
|
|
30
|
+
)}
|
|
27
31
|
lang={lang}
|
|
28
32
|
suppressHydrationWarning
|
|
29
33
|
>
|
|
30
|
-
<
|
|
34
|
+
<head>
|
|
35
|
+
<GeistdocsThemeScript />
|
|
36
|
+
</head>
|
|
37
|
+
<body style={{ backgroundColor: "var(--ds-background-200)" }}>
|
|
31
38
|
<GeistdocsProvider basePath={config.basePath} lang={lang}>
|
|
32
39
|
<Navbar config={config} />
|
|
33
40
|
{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
|
|
|
@@ -42,7 +45,7 @@
|
|
|
42
45
|
|
|
43
46
|
/* TOC and footer links use gray-1000 */
|
|
44
47
|
#nd-toc {
|
|
45
|
-
@apply text-gray-1000
|
|
48
|
+
@apply text-gray-1000;
|
|
46
49
|
}
|
|
47
50
|
|
|
48
51
|
#nd-toc a {
|
|
@@ -5,7 +5,7 @@ import { cva, type VariantProps } from "class-variance-authority"
|
|
|
5
5
|
import { cn } from "@/lib/utils"
|
|
6
6
|
|
|
7
7
|
const buttonVariants = cva(
|
|
8
|
-
"inline-flex items-center justify-center gap-2 whitespace-nowrap rounded-md text-sm font-medium transition-
|
|
8
|
+
"inline-flex items-center justify-center gap-2 whitespace-nowrap rounded-md text-sm font-medium transition-colors disabled:pointer-events-none disabled:opacity-50 [&_svg]:pointer-events-none [&_svg:not([class*='size-'])]:size-4 shrink-0 [&_svg]:shrink-0 outline-none focus-visible:border-gray-600 focus-visible:ring-gray-600/50 focus-visible:ring-[3px] aria-invalid:ring-red-800/20 dark:aria-invalid:ring-red-800/40 aria-invalid:border-red-800",
|
|
9
9
|
{
|
|
10
10
|
variants: {
|
|
11
11
|
variant: {
|
|
@@ -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
|
);
|
|
@@ -25,6 +25,7 @@ Configure Geistdocs through user-owned files in the generated project. Runtime f
|
|
|
25
25
|
| File | Purpose |
|
|
26
26
|
| --- | --- |
|
|
27
27
|
| `geistdocs.tsx` | Site-level settings, including logo, nav, GitHub repo, AI prompt, agent-readiness metadata, translations, and feature flags. |
|
|
28
|
+
| `next.config.ts` | Composes Fumadocs MDX, discovers App Router routes, and configures Next.js. |
|
|
28
29
|
| `source.config.ts` | Configures Fumadocs collections with the package-provided schema, Markdown plugins, and syntax theme. |
|
|
29
30
|
| `lib/geistdocs/config.tsx` | Converts `geistdocs.tsx` exports into the package config using `defineConfig`. |
|
|
30
31
|
| `source.config.ts` | Configures Fumadocs collections with package-safe schemas and Markdown processing. |
|
|
@@ -214,11 +215,18 @@ To serve docs from the site root, use `route: "/"` in `content` and `baseUrl: "/
|
|
|
214
215
|
When Next.js mounts the application below a path, set the same value in `next.config.ts` and Geistdocs config:
|
|
215
216
|
|
|
216
217
|
```ts title="next.config.ts"
|
|
218
|
+
import { createGeistdocs } from "@vercel/geistdocs/next";
|
|
219
|
+
import type { NextConfig } from "next";
|
|
220
|
+
|
|
221
|
+
const withGeistdocs = createGeistdocs();
|
|
222
|
+
|
|
217
223
|
const config: NextConfig = {
|
|
218
224
|
basePath: "/docs",
|
|
219
225
|
cacheComponents: true,
|
|
220
226
|
partialPrefetching: true,
|
|
221
227
|
};
|
|
228
|
+
|
|
229
|
+
export default withGeistdocs(config);
|
|
222
230
|
```
|
|
223
231
|
|
|
224
232
|
```tsx title="geistdocs.tsx"
|
|
@@ -69,7 +69,6 @@ import { geistdocsSource } from "@/lib/geistdocs/source";
|
|
|
69
69
|
|
|
70
70
|
export const { GET, generateStaticParams } =
|
|
71
71
|
createDocsMarkdownRoute({
|
|
72
|
-
notFound: {},
|
|
73
72
|
sources: [geistdocsSource],
|
|
74
73
|
});
|
|
75
74
|
```
|
|
@@ -93,7 +92,7 @@ When a Markdown request does not match a page, Geistdocs returns an agent-readab
|
|
|
93
92
|
|
|
94
93
|
For example, a request for `/docs/env-vars` can suggest `/docs/environment-variables.md`. The response uses a short cache lifetime and returns a real `404` status. It also sends `X-Robots-Tag: noindex` and no canonical link because the requested page does not exist. Regular HTML requests keep the app's standard not-found behavior.
|
|
95
94
|
|
|
96
|
-
|
|
95
|
+
The suggestion response is enabled by default. Pass `notFound: { status: 410 }` for permanently removed pages, or `notFound: false` to use the standard Next.js not-found response. Legacy `status: 200` values are treated as `404` so missing pages always return a real error status.
|
|
97
96
|
|
|
98
97
|
If a custom `markdownRoutes` mapping changes the public path shape, set `notFound.getRequestedPath` to reconstruct the app-local public pathname. This also keeps page lookup and suggestions within the right source when a flattened route serves multiple sources:
|
|
99
98
|
|
|
@@ -110,15 +109,19 @@ Set `notFound.getPageMarkdownUrl` as well when suggested pages use a custom app-
|
|
|
110
109
|
|
|
111
110
|
### Unmatched application paths
|
|
112
111
|
|
|
113
|
-
|
|
112
|
+
When `agent` is enabled, `createGeistdocs` scans App Router pages and route handlers during `next dev` and `next build`. `createProxy` uses that generated manifest to distinguish valid application routes from unknown paths. Valid routes continue to the app's HTML or route-handler response. Unknown Markdown or detected-agent `GET` and `HEAD` requests receive a concise 404 with links to the docs, `sitemap.md`, and `llms.txt`.
|
|
114
113
|
|
|
115
|
-
|
|
114
|
+
Markdown mappings take precedence over generated app routes, so a route that has both HTML and Markdown continues to negotiate Markdown. Dynamic app routes are treated as potentially valid; the app remains responsible for returning its own 404 when a specific slug does not exist.
|
|
115
|
+
|
|
116
|
+
Pass `markdownNotFound: false` to disable automatic unmatched-path recovery:
|
|
116
117
|
|
|
117
118
|
```ts title="proxy.ts"
|
|
118
119
|
const proxy = createProxy({
|
|
119
120
|
config: geistdocsConfig,
|
|
120
|
-
markdownNotFound:
|
|
121
|
+
markdownNotFound: false,
|
|
121
122
|
});
|
|
122
123
|
```
|
|
123
124
|
|
|
125
|
+
Sites that do not use `createGeistdocs` keep the previous opt-in behavior. Existing boolean and predicate forms remain supported for compatibility.
|
|
126
|
+
|
|
124
127
|
`createNotFoundRoute` remains available for apps that prefer an explicit catch-all Route Handler with Geistdocs' minimal HTML response.
|
|
@@ -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
|
|
|
@@ -56,24 +56,26 @@ If you are starting from a generated Geistdocs project and moving content into i
|
|
|
56
56
|
pnpm dlx @vercel/geistdocs init --name my-docs
|
|
57
57
|
```
|
|
58
58
|
|
|
59
|
-
##
|
|
59
|
+
## Configure Next.js
|
|
60
60
|
|
|
61
|
-
Geistdocs
|
|
61
|
+
The Geistdocs Next.js integration composes Fumadocs MDX, enables automatic app-route discovery for agent-readable 404s, and preserves your Next.js configuration. Enable Cache Components in the same file:
|
|
62
62
|
|
|
63
63
|
```ts title="next.config.ts"
|
|
64
|
-
import {
|
|
64
|
+
import { createGeistdocs } from "@vercel/geistdocs/next";
|
|
65
65
|
import type { NextConfig } from "next";
|
|
66
66
|
|
|
67
|
-
const
|
|
67
|
+
const withGeistdocs = createGeistdocs();
|
|
68
68
|
|
|
69
69
|
const config: NextConfig = {
|
|
70
70
|
cacheComponents: true,
|
|
71
71
|
partialPrefetching: true,
|
|
72
72
|
};
|
|
73
73
|
|
|
74
|
-
export default
|
|
74
|
+
export default withGeistdocs(config);
|
|
75
75
|
```
|
|
76
76
|
|
|
77
|
+
Restart `next dev` after adding, deleting, or renaming an App Router page or route. Production builds always regenerate the route manifest.
|
|
78
|
+
|
|
77
79
|
Every root dynamic parameter needs at least one value from `generateStaticParams`. For a site with a `[lang]` root segment, return every configured language from the root layout:
|
|
78
80
|
|
|
79
81
|
```tsx title="app/[lang]/layout.tsx"
|
|
@@ -373,16 +375,14 @@ For a base-path application whose root page is documentation, add `"/"` to the s
|
|
|
373
375
|
Tailwind CSS v4 requires `@source` entries for package components and related dependencies.
|
|
374
376
|
|
|
375
377
|
```css title="app/styles/geistdocs.css"
|
|
376
|
-
@import "
|
|
378
|
+
@import "@vercel/geistcn/tailwind.css";
|
|
379
|
+
@import "@vercel/geistcn/styles.css";
|
|
377
380
|
@import "fumadocs-ui/css/shadcn.css";
|
|
378
381
|
@import "fumadocs-ui/css/preset.css";
|
|
379
|
-
@import "
|
|
380
|
-
|
|
381
|
-
@source "../../node_modules/@vercel/geistdocs/dist/**/*.js";
|
|
382
|
-
@source "../../node_modules/streamdown/dist/*.js";
|
|
382
|
+
@import "@vercel/geistdocs/theme.css";
|
|
383
383
|
```
|
|
384
384
|
|
|
385
|
-
|
|
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.
|
|
386
386
|
|
|
387
387
|
## Handle environment variables
|
|
388
388
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
title: Proxy and markdown routes
|
|
3
3
|
description: Add custom request logic while keeping Geistdocs markdown negotiation in the package
|
|
4
4
|
type: reference
|
|
5
|
-
summary: Configure createProxy with
|
|
5
|
+
summary: Configure createProxy with generated route discovery, request hooks, markdown mappings, and a static Next.js matcher.
|
|
6
6
|
prerequisites:
|
|
7
7
|
- /docs/configuration
|
|
8
8
|
related:
|
|
@@ -177,6 +177,25 @@ export const config = {
|
|
|
177
177
|
|
|
178
178
|
The package keeps `llms.txt`, `sitemap.md`, `agents.md`, MCP discovery, and RSS out of root page-Markdown negotiation. Continue to exclude site-specific application and API routes with the matcher or a `before` hook. A root Markdown page is exposed as `/index.md`, or `<basePath>/index.md` publicly.
|
|
179
179
|
|
|
180
|
+
## Recover unmatched Markdown requests
|
|
181
|
+
|
|
182
|
+
`createGeistdocs` in `next.config.ts` generates a lightweight manifest from App Router pages and route handlers. When `agent` is enabled, `createProxy` uses this manifest to return a Markdown 404 only when a `GET` or `HEAD` request matches neither a Markdown mapping nor an application route.
|
|
183
|
+
|
|
184
|
+
The manifest contains route patterns, not page modules or content. Static, dynamic, catch-all, optional catch-all, grouped, and localized routes continue to Next.js. Root catch-all pages are treated as potentially valid, so the app remains responsible for their 404 behavior. The package's own `[...not-found]` route handler is excluded so it does not claim every path.
|
|
185
|
+
|
|
186
|
+
The integration also resolves `next.config.ts` rewrites. Static rewrite sources are matched exactly, while parameterized sources protect their safe static prefix. If a rewrite begins with a dynamic root segment, Geistdocs disables automatic recovery rather than risk returning a Markdown 404 for a real rewritten route.
|
|
187
|
+
|
|
188
|
+
No proxy option is required. Pass `markdownNotFound: false` only when the site needs to disable automatic recovery:
|
|
189
|
+
|
|
190
|
+
```ts title="proxy.ts"
|
|
191
|
+
const proxy = createProxy({
|
|
192
|
+
config: geistdocsConfig,
|
|
193
|
+
markdownNotFound: false,
|
|
194
|
+
});
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
Existing sites that use `createMDX` directly do not receive a generated manifest and keep the previous opt-in behavior. Restart `next dev` after adding, deleting, or renaming a route; production builds always regenerate the manifest.
|
|
198
|
+
|
|
180
199
|
## Hook context
|
|
181
200
|
|
|
182
201
|
Both `before` and `after` receive the same context:
|
|
@@ -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
|
|
@@ -65,11 +67,17 @@ Headings automatically generate anchor links for navigation and deep linking.
|
|
|
65
67
|
|
|
66
68
|
Create unordered lists with `-`, `*`, or `+`:
|
|
67
69
|
|
|
68
|
-
|
|
69
|
-
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
70
|
+
```md
|
|
71
|
+
- Install the required packages
|
|
72
|
+
- Configure your project
|
|
73
|
+
- Start the development server
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
This renders as:
|
|
77
|
+
|
|
78
|
+
- Install the required packages
|
|
79
|
+
- Configure your project
|
|
80
|
+
- Start the development server
|
|
73
81
|
|
|
74
82
|
Create ordered lists with numbers:
|
|
75
83
|
|
|
@@ -81,7 +89,69 @@ Create ordered lists with numbers:
|
|
|
81
89
|
|
|
82
90
|
Use `>` to create blockquotes:
|
|
83
91
|
|
|
84
|
-
>
|
|
92
|
+
> **Watch:** Learn more about how to use `next/image` → [YouTube (9 minutes)](https://youtu.be/IU_qq_c_lKA).
|
|
93
|
+
|
|
94
|
+
### Callouts
|
|
95
|
+
|
|
96
|
+
Use `<Callout>` for a highlighted informational note:
|
|
97
|
+
|
|
98
|
+
```mdx
|
|
99
|
+
<Callout>This is automatically set when deploying to Vercel.</Callout>
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
This renders as:
|
|
103
|
+
|
|
104
|
+
<Callout>This is automatically set when deploying to Vercel.</Callout>
|
|
105
|
+
|
|
106
|
+
Callouts can also contain a title and lists:
|
|
107
|
+
|
|
108
|
+
<Callout title="Good to know">
|
|
109
|
+
- The `App Router` uses [React canary
|
|
110
|
+
releases](https://react.dev/blog/2023/05/03/react-canaries) built-in, which
|
|
111
|
+
include all the stable React 19 changes, as well as newer features being
|
|
112
|
+
validated in frameworks, but you should still declare react and react-dom in
|
|
113
|
+
package.json for tooling and ecosystem compatibility.
|
|
114
|
+
- The `Pages Router` uses the React version from your `package.json`.
|
|
115
|
+
</Callout>
|
|
116
|
+
|
|
117
|
+
### Copy Prompts
|
|
118
|
+
|
|
119
|
+
Short prompts render in full without an expansion control:
|
|
120
|
+
|
|
121
|
+
```mdx
|
|
122
|
+
<CopyPrompt text="Summarize this documentation page and list the key concepts.">
|
|
123
|
+
Summarize this documentation page and list the key concepts.
|
|
124
|
+
</CopyPrompt>
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
This renders as:
|
|
128
|
+
|
|
129
|
+
<CopyPrompt text="Summarize this documentation page and list the key concepts.">
|
|
130
|
+
Summarize this documentation page and list the key concepts.
|
|
131
|
+
</CopyPrompt>
|
|
132
|
+
|
|
133
|
+
Long prompts initially show a preview with a **Show more** control:
|
|
134
|
+
|
|
135
|
+
```mdx
|
|
136
|
+
<CopyPrompt collapsible text="Write a detailed migration plan for this project.">
|
|
137
|
+
Write a detailed migration plan for this project. Include prerequisites,
|
|
138
|
+
implementation steps, validation, rollback guidance, and common pitfalls.
|
|
139
|
+
</CopyPrompt>
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
Set the boolean `collapsible` prop when the prompt should initially render as a
|
|
143
|
+
two-line preview. This renders as:
|
|
144
|
+
|
|
145
|
+
<CopyPrompt collapsible text="Review this Geistdocs project in detail. Explain how the @vercel/geistdocs package, application layouts, local adapter files, source configuration, content/docs directory, navigation metadata, MDX components, syntax highlighting, search routes, and deployment configuration work together. Then identify the safest first files to edit, describe the effect of each change, call out common mistakes, and propose a step-by-step plan for customizing the documentation site without breaking routing, generated Markdown, or accessibility behavior.">
|
|
146
|
+
Review this Geistdocs project in detail. Explain how the `@vercel/geistdocs`
|
|
147
|
+
package, application layouts, local adapter files, source configuration,
|
|
148
|
+
`content/docs` directory, navigation metadata, MDX components, syntax
|
|
149
|
+
highlighting, search routes, and deployment configuration work together.
|
|
150
|
+
Then identify the safest first files to edit, describe the effect of each
|
|
151
|
+
change, call out common mistakes, and propose a step-by-step plan for
|
|
152
|
+
customizing the documentation site without breaking routing, generated
|
|
153
|
+
Markdown, or accessibility behavior.
|
|
154
|
+
</CopyPrompt>
|
|
85
155
|
|
|
86
156
|
### Links
|
|
87
157
|
|
|
@@ -90,6 +160,26 @@ Create links with `[text](url)`:
|
|
|
90
160
|
- [External link](https://vercel.com)
|
|
91
161
|
- [Internal link](/docs/getting-started)
|
|
92
162
|
|
|
163
|
+
Use an absolute `https://` or `http://` URL to mark a link as external. External
|
|
164
|
+
links open outside the docs site and display an arrow icon. Use a root-relative
|
|
165
|
+
path beginning with `/` for internal links:
|
|
166
|
+
|
|
167
|
+
```md
|
|
168
|
+
[External link](https://vercel.com)
|
|
169
|
+
[Internal link](/docs/getting-started)
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
External links can also contain inline code. The underline applies to the text,
|
|
173
|
+
but not the external-link icon:
|
|
174
|
+
|
|
175
|
+
```md
|
|
176
|
+
Run independent requests in parallel with [`Promise.all`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise/all).
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
This renders as:
|
|
180
|
+
|
|
181
|
+
Run independent requests in parallel with [`Promise.all`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise/all).
|
|
182
|
+
|
|
93
183
|
### Images
|
|
94
184
|
|
|
95
185
|
Add images with ``:
|
|
@@ -122,6 +212,16 @@ This renders as:
|
|
|
122
212
|
| GFM | GitHub extensions | Supported |
|
|
123
213
|
| MDX | JSX in Markdown | Supported |
|
|
124
214
|
|
|
215
|
+
Tables can also include inline code, as commonly used for file references:
|
|
216
|
+
|
|
217
|
+
| File | Description |
|
|
218
|
+
| -------------------- | ------------------------------------------------ |
|
|
219
|
+
| `next.config.js` | Configuration file for Next.js |
|
|
220
|
+
| `package.json` | Project dependencies and scripts |
|
|
221
|
+
| `instrumentation.ts` | OpenTelemetry and instrumentation file |
|
|
222
|
+
| `.env.local` | Local environment variables |
|
|
223
|
+
| `tsconfig.json` | Configuration file for TypeScript |
|
|
224
|
+
|
|
125
225
|
### Task Lists
|
|
126
226
|
|
|
127
227
|
Create interactive task lists:
|
|
@@ -194,6 +294,78 @@ export const Button = ({ children }) => {
|
|
|
194
294
|
};
|
|
195
295
|
```
|
|
196
296
|
|
|
297
|
+
### Tabs and switchers
|
|
298
|
+
|
|
299
|
+
Use consecutive fences with `tab` metadata for code tabs that expose every
|
|
300
|
+
option at once:
|
|
301
|
+
|
|
302
|
+
````md
|
|
303
|
+
```ts tab="TypeScript" title="example.ts"
|
|
304
|
+
export const greeting: string = "Hello from TypeScript";
|
|
305
|
+
```
|
|
306
|
+
|
|
307
|
+
```js tab="JavaScript" title="example.js"
|
|
308
|
+
export const greeting = "Hello from JavaScript";
|
|
309
|
+
```
|
|
310
|
+
````
|
|
311
|
+
|
|
312
|
+
This renders as:
|
|
313
|
+
|
|
314
|
+
```ts tab="TypeScript" title="example.ts"
|
|
315
|
+
export const greeting: string = "Hello from TypeScript";
|
|
316
|
+
```
|
|
317
|
+
|
|
318
|
+
```js tab="JavaScript" title="example.js"
|
|
319
|
+
export const greeting = "Hello from JavaScript";
|
|
320
|
+
```
|
|
321
|
+
|
|
322
|
+
Wrap the same fences in `<CodeBlockTabs compact>` to move the selector into the
|
|
323
|
+
code-block header:
|
|
324
|
+
|
|
325
|
+
````mdx
|
|
326
|
+
<CompactCodeBlockTabs defaultValue="TypeScript">
|
|
327
|
+
<CodeBlockTabsList>
|
|
328
|
+
<CodeBlockTabsTrigger value="TypeScript">TypeScript</CodeBlockTabsTrigger>
|
|
329
|
+
<CodeBlockTabsTrigger value="JavaScript">JavaScript</CodeBlockTabsTrigger>
|
|
330
|
+
</CodeBlockTabsList>
|
|
331
|
+
<CodeBlockTab value="TypeScript">
|
|
332
|
+
```ts title="example.ts"
|
|
333
|
+
export const greeting: string = "Hello from TypeScript";
|
|
334
|
+
```
|
|
335
|
+
</CodeBlockTab>
|
|
336
|
+
<CodeBlockTab value="JavaScript">
|
|
337
|
+
```js title="example.js"
|
|
338
|
+
export const greeting = "Hello from JavaScript";
|
|
339
|
+
```
|
|
340
|
+
</CodeBlockTab>
|
|
341
|
+
</CompactCodeBlockTabs>
|
|
342
|
+
````
|
|
343
|
+
|
|
344
|
+
This renders as:
|
|
345
|
+
|
|
346
|
+
<CompactCodeBlockTabs defaultValue="TypeScript">
|
|
347
|
+
<CodeBlockTabsList>
|
|
348
|
+
<CodeBlockTabsTrigger value="TypeScript">TypeScript</CodeBlockTabsTrigger>
|
|
349
|
+
<CodeBlockTabsTrigger value="JavaScript">JavaScript</CodeBlockTabsTrigger>
|
|
350
|
+
</CodeBlockTabsList>
|
|
351
|
+
<CodeBlockTab value="TypeScript">
|
|
352
|
+
```ts title="example.ts"
|
|
353
|
+
export const greeting: string = "Hello from TypeScript";
|
|
354
|
+
```
|
|
355
|
+
</CodeBlockTab>
|
|
356
|
+
<CodeBlockTab value="JavaScript">
|
|
357
|
+
```js title="example.js"
|
|
358
|
+
export const greeting = "Hello from JavaScript";
|
|
359
|
+
```
|
|
360
|
+
</CodeBlockTab>
|
|
361
|
+
</CompactCodeBlockTabs>
|
|
362
|
+
|
|
363
|
+
When migrating an existing site such as next-site, translate adjacent
|
|
364
|
+
`switcher` fences to `tab="TypeScript"` and `tab="JavaScript"`, then wrap the
|
|
365
|
+
pair with `<CodeBlockTabs compact>`. Import `@vercel/geistdocs/styles.css` (or
|
|
366
|
+
`theme.css` with the documented Geist dependencies) so Tailwind scans the
|
|
367
|
+
package's compiled components and emits the tab layout utilities.
|
|
368
|
+
|
|
197
369
|
### Framework icons
|
|
198
370
|
|
|
199
371
|
Append `#<framework>` to the title to show a framework logo instead of the
|
|
@@ -202,22 +374,22 @@ values are `#next` / `#nextjs` and `#svelte` / `#sveltekit`:
|
|
|
202
374
|
|
|
203
375
|
````md
|
|
204
376
|
```ts title="flags.ts#next"
|
|
205
|
-
import { flag } from
|
|
377
|
+
import { flag } from "flags/next";
|
|
206
378
|
```
|
|
207
379
|
|
|
208
380
|
```ts title="flags.ts#svelte"
|
|
209
|
-
import { flag } from
|
|
381
|
+
import { flag } from "flags/sveltekit";
|
|
210
382
|
```
|
|
211
383
|
````
|
|
212
384
|
|
|
213
385
|
This renders as:
|
|
214
386
|
|
|
215
387
|
```ts title="flags.ts#next"
|
|
216
|
-
import { flag } from
|
|
388
|
+
import { flag } from "flags/next";
|
|
217
389
|
```
|
|
218
390
|
|
|
219
391
|
```ts title="flags.ts#svelte"
|
|
220
|
-
import { flag } from
|
|
392
|
+
import { flag } from "flags/sveltekit";
|
|
221
393
|
```
|
|
222
394
|
|
|
223
395
|
### 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
|
},
|