@vercel/geistdocs 1.24.1 → 1.25.1-canary.5684bb5
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 +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/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 +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 +9 -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 +165 -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 +112 -11
- package/docs/pages/versioned-docs.md +3 -3
- package/docs/sitemap.md +1 -2
- package/package.json +14 -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 +7 -4
- package/template/app/[lang]/llms.mdx/[[...slug]]/route.ts +0 -1
- package/template/app/styles/geistdocs.css +17 -14
- 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 +112 -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 +71 -700
- 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
package/docs/pages/syntax.md
CHANGED
|
@@ -15,7 +15,9 @@ related:
|
|
|
15
15
|
|
|
16
16
|
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.
|
|
17
17
|
|
|
18
|
-
Help me write a Geistdocs MDX page. Use this page as a syntax reference and
|
|
18
|
+
Help me write a Geistdocs MDX page. Use this page as a syntax reference and
|
|
19
|
+
create an example page with frontmatter, headings, links, a code block, a
|
|
20
|
+
`Callout`, and a `CopyPrompt` component.
|
|
19
21
|
|
|
20
22
|
## Frontmatter
|
|
21
23
|
|
|
@@ -67,11 +69,17 @@ Headings automatically generate anchor links for navigation and deep linking.
|
|
|
67
69
|
|
|
68
70
|
Create unordered lists with `-`, `*`, or `+`:
|
|
69
71
|
|
|
70
|
-
|
|
71
|
-
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
72
|
+
```md
|
|
73
|
+
- Install the required packages
|
|
74
|
+
- Configure your project
|
|
75
|
+
- Start the development server
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
This renders as:
|
|
79
|
+
|
|
80
|
+
- Install the required packages
|
|
81
|
+
- Configure your project
|
|
82
|
+
- Start the development server
|
|
75
83
|
|
|
76
84
|
Create ordered lists with numbers:
|
|
77
85
|
|
|
@@ -83,7 +91,19 @@ Create ordered lists with numbers:
|
|
|
83
91
|
|
|
84
92
|
Use `>` to create blockquotes:
|
|
85
93
|
|
|
86
|
-
>
|
|
94
|
+
> **Watch:** Learn more about how to use `next/image` → [YouTube (9 minutes)](https://youtu.be/IU_qq_c_lKA).
|
|
95
|
+
|
|
96
|
+
### Callouts
|
|
97
|
+
|
|
98
|
+
Use `<Callout>` for a highlighted informational note:
|
|
99
|
+
|
|
100
|
+
```mdx
|
|
101
|
+
<Callout>This is automatically set when deploying to Vercel.</Callout>
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
This renders as:
|
|
105
|
+
|
|
106
|
+
> This is automatically set when deploying to Vercel.
|
|
87
107
|
|
|
88
108
|
### Links
|
|
89
109
|
|
|
@@ -92,6 +112,15 @@ Create links with `[text](url)`:
|
|
|
92
112
|
- [External link](https://vercel.com)
|
|
93
113
|
- [Internal link](/docs/getting-started)
|
|
94
114
|
|
|
115
|
+
Use an absolute `https://` or `http://` URL to mark a link as external. External
|
|
116
|
+
links open outside the docs site and display an arrow icon. Use a root-relative
|
|
117
|
+
path beginning with `/` for internal links:
|
|
118
|
+
|
|
119
|
+
```md
|
|
120
|
+
[External link](https://vercel.com)
|
|
121
|
+
[Internal link](/docs/getting-started)
|
|
122
|
+
```
|
|
123
|
+
|
|
95
124
|
### Images
|
|
96
125
|
|
|
97
126
|
Add images with ``:
|
|
@@ -196,6 +225,78 @@ export const Button = ({ children }) => {
|
|
|
196
225
|
};
|
|
197
226
|
```
|
|
198
227
|
|
|
228
|
+
### Tabs and switchers
|
|
229
|
+
|
|
230
|
+
Use consecutive fences with `tab` metadata for code tabs that expose every
|
|
231
|
+
option at once:
|
|
232
|
+
|
|
233
|
+
````md
|
|
234
|
+
```ts tab="TypeScript" title="example.ts"
|
|
235
|
+
export const greeting: string = "Hello from TypeScript";
|
|
236
|
+
```
|
|
237
|
+
|
|
238
|
+
```js tab="JavaScript" title="example.js"
|
|
239
|
+
export const greeting = "Hello from JavaScript";
|
|
240
|
+
```
|
|
241
|
+
````
|
|
242
|
+
|
|
243
|
+
This renders as:
|
|
244
|
+
|
|
245
|
+
```ts tab="TypeScript" title="example.ts"
|
|
246
|
+
export const greeting: string = "Hello from TypeScript";
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
```js tab="JavaScript" title="example.js"
|
|
250
|
+
export const greeting = "Hello from JavaScript";
|
|
251
|
+
```
|
|
252
|
+
|
|
253
|
+
Wrap the same fences in `<CodeBlockTabs compact>` to move the selector into the
|
|
254
|
+
code-block header:
|
|
255
|
+
|
|
256
|
+
````mdx
|
|
257
|
+
<CompactCodeBlockTabs defaultValue="TypeScript">
|
|
258
|
+
<CodeBlockTabsList>
|
|
259
|
+
<CodeBlockTabsTrigger value="TypeScript">TypeScript</CodeBlockTabsTrigger>
|
|
260
|
+
<CodeBlockTabsTrigger value="JavaScript">JavaScript</CodeBlockTabsTrigger>
|
|
261
|
+
</CodeBlockTabsList>
|
|
262
|
+
<CodeBlockTab value="TypeScript">
|
|
263
|
+
```ts title="example.ts"
|
|
264
|
+
export const greeting: string = "Hello from TypeScript";
|
|
265
|
+
```
|
|
266
|
+
</CodeBlockTab>
|
|
267
|
+
<CodeBlockTab value="JavaScript">
|
|
268
|
+
```js title="example.js"
|
|
269
|
+
export const greeting = "Hello from JavaScript";
|
|
270
|
+
```
|
|
271
|
+
</CodeBlockTab>
|
|
272
|
+
</CompactCodeBlockTabs>
|
|
273
|
+
````
|
|
274
|
+
|
|
275
|
+
This renders as:
|
|
276
|
+
|
|
277
|
+
<CompactCodeBlockTabs defaultValue="TypeScript">
|
|
278
|
+
<CodeBlockTabsList>
|
|
279
|
+
<CodeBlockTabsTrigger value="TypeScript">TypeScript</CodeBlockTabsTrigger>
|
|
280
|
+
<CodeBlockTabsTrigger value="JavaScript">JavaScript</CodeBlockTabsTrigger>
|
|
281
|
+
</CodeBlockTabsList>
|
|
282
|
+
<CodeBlockTab value="TypeScript">
|
|
283
|
+
```ts title="example.ts"
|
|
284
|
+
export const greeting: string = "Hello from TypeScript";
|
|
285
|
+
```
|
|
286
|
+
</CodeBlockTab>
|
|
287
|
+
<CodeBlockTab value="JavaScript">
|
|
288
|
+
```js title="example.js"
|
|
289
|
+
export const greeting = "Hello from JavaScript";
|
|
290
|
+
```
|
|
291
|
+
</CodeBlockTab>
|
|
292
|
+
</CompactCodeBlockTabs>
|
|
293
|
+
|
|
294
|
+
When migrating an existing site such as next-site, translate adjacent
|
|
295
|
+
`switcher` fences to `tab="TypeScript"` and `tab="JavaScript"`, then wrap the
|
|
296
|
+
pair with `<CodeBlockTabs compact>`. Import `@vercel/geistdocs/styles.css` (or
|
|
297
|
+
`theme.css` with the documented Geist dependencies) so Tailwind scans the
|
|
298
|
+
package's compiled components and emits the tab layout utilities.
|
|
299
|
+
|
|
199
300
|
### Framework icons
|
|
200
301
|
|
|
201
302
|
Append `#<framework>` to the title to show a framework logo instead of the
|
|
@@ -204,22 +305,22 @@ values are `#next` / `#nextjs` and `#svelte` / `#sveltekit`:
|
|
|
204
305
|
|
|
205
306
|
````md
|
|
206
307
|
```ts title="flags.ts#next"
|
|
207
|
-
import { flag } from
|
|
308
|
+
import { flag } from "flags/next";
|
|
208
309
|
```
|
|
209
310
|
|
|
210
311
|
```ts title="flags.ts#svelte"
|
|
211
|
-
import { flag } from
|
|
312
|
+
import { flag } from "flags/sveltekit";
|
|
212
313
|
```
|
|
213
314
|
````
|
|
214
315
|
|
|
215
316
|
This renders as:
|
|
216
317
|
|
|
217
318
|
```ts title="flags.ts#next"
|
|
218
|
-
import { flag } from
|
|
319
|
+
import { flag } from "flags/next";
|
|
219
320
|
```
|
|
220
321
|
|
|
221
322
|
```ts title="flags.ts#svelte"
|
|
222
|
-
import { flag } from
|
|
323
|
+
import { flag } from "flags/sveltekit";
|
|
223
324
|
```
|
|
224
325
|
|
|
225
326
|
### Line Numbers
|
|
@@ -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
|
@@ -12,7 +12,7 @@ Use it to choose focused page files from `docs/pages/` before reading the full `
|
|
|
12
12
|
- [Syntax](pages/syntax.md) | URL: /docs/syntax | Type: reference | Summary: Supported MDX syntax including text formatting, code blocks, line highlighting, and Mermaid diagrams.
|
|
13
13
|
- [Geistdocs Provider](pages/provider.md) | URL: /docs/provider | Type: reference | Summary: The root provider component that wraps your application to handle toast notifications, search, and analytics.
|
|
14
14
|
- [Versioned docs](pages/versioned-docs.md) | URL: /docs/versioned-docs | Type: guide | Summary: Use createVersionedSources to configure stable, pre-release, or host-based documentation versions.
|
|
15
|
-
- [Proxy and markdown routes](pages/proxy.md) | URL: /docs/proxy | Type: reference | Summary: Configure createProxy with
|
|
15
|
+
- [Proxy and markdown routes](pages/proxy.md) | URL: /docs/proxy | Type: reference | Summary: Configure createProxy with generated route discovery, request hooks, markdown mappings, and a static Next.js matcher.
|
|
16
16
|
- [.md Extension](pages/md.md) | URL: /docs/md | Type: conceptual | Summary: Access any documentation page as raw Markdown by appending .md or .mdx to the URL for AI tool consumption.
|
|
17
17
|
- [Agent readiness](pages/agent-readiness.md) | URL: /docs/agent-readiness | Type: guide | Summary: Generate /agents.md and /.well-known/mcp.json from Geistdocs config so agents can find docs, Markdown surfaces, API specs, and MCP endpoints.
|
|
18
18
|
- [Ask AI](pages/ask-ai.md) | URL: /docs/ask-ai | Type: conceptual | Summary: An AI-powered chat assistant with context-aware search, persistent history, and suggested prompts for your documentation.
|
|
@@ -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.
|
|
4
|
+
"version": "1.25.1-canary.5684bb5",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
@@ -110,6 +110,10 @@
|
|
|
110
110
|
"types": "./dist/proxy.d.ts",
|
|
111
111
|
"default": "./dist/proxy.js"
|
|
112
112
|
},
|
|
113
|
+
"./next": {
|
|
114
|
+
"types": "./dist/next.d.ts",
|
|
115
|
+
"default": "./dist/next.js"
|
|
116
|
+
},
|
|
113
117
|
"./mdx": {
|
|
114
118
|
"types": "./dist/mdx.d.ts",
|
|
115
119
|
"default": "./dist/mdx.js"
|
|
@@ -127,26 +131,10 @@
|
|
|
127
131
|
"types": "./dist/shiki-theme.d.ts",
|
|
128
132
|
"default": "./dist/shiki-theme.js"
|
|
129
133
|
},
|
|
130
|
-
"./components/badge": {
|
|
131
|
-
"types": "./dist/components/badge.d.ts",
|
|
132
|
-
"default": "./dist/components/badge.js"
|
|
133
|
-
},
|
|
134
|
-
"./components/button": {
|
|
135
|
-
"types": "./dist/components/button.d.ts",
|
|
136
|
-
"default": "./dist/components/button.js"
|
|
137
|
-
},
|
|
138
|
-
"./components/button-group": {
|
|
139
|
-
"types": "./dist/components/button-group.d.ts",
|
|
140
|
-
"default": "./dist/components/button-group.js"
|
|
141
|
-
},
|
|
142
134
|
"./components/callout": {
|
|
143
135
|
"types": "./dist/components/callout.d.ts",
|
|
144
136
|
"default": "./dist/components/callout.js"
|
|
145
137
|
},
|
|
146
|
-
"./components/card": {
|
|
147
|
-
"types": "./dist/components/card.d.ts",
|
|
148
|
-
"default": "./dist/components/card.js"
|
|
149
|
-
},
|
|
150
138
|
"./components/code-block": {
|
|
151
139
|
"types": "./dist/components/code-block.d.ts",
|
|
152
140
|
"default": "./dist/components/code-block.js"
|
|
@@ -167,34 +155,10 @@
|
|
|
167
155
|
"types": "./dist/components/copy-prompt.d.ts",
|
|
168
156
|
"default": "./dist/components/copy-prompt.js"
|
|
169
157
|
},
|
|
170
|
-
"./components/dialog": {
|
|
171
|
-
"types": "./dist/components/dialog.d.ts",
|
|
172
|
-
"default": "./dist/components/dialog.js"
|
|
173
|
-
},
|
|
174
|
-
"./components/drawer": {
|
|
175
|
-
"types": "./dist/components/drawer.d.ts",
|
|
176
|
-
"default": "./dist/components/drawer.js"
|
|
177
|
-
},
|
|
178
158
|
"./components/dropdown-menu": {
|
|
179
159
|
"types": "./dist/components/dropdown-menu.d.ts",
|
|
180
160
|
"default": "./dist/components/dropdown-menu.js"
|
|
181
161
|
},
|
|
182
|
-
"./components/input": {
|
|
183
|
-
"types": "./dist/components/input.d.ts",
|
|
184
|
-
"default": "./dist/components/input.js"
|
|
185
|
-
},
|
|
186
|
-
"./components/input-group": {
|
|
187
|
-
"types": "./dist/components/input-group.d.ts",
|
|
188
|
-
"default": "./dist/components/input-group.js"
|
|
189
|
-
},
|
|
190
|
-
"./components/kbd": {
|
|
191
|
-
"types": "./dist/components/kbd.d.ts",
|
|
192
|
-
"default": "./dist/components/kbd.js"
|
|
193
|
-
},
|
|
194
|
-
"./components/theme-aware-image": {
|
|
195
|
-
"types": "./dist/components/theme-aware-image.d.ts",
|
|
196
|
-
"default": "./dist/components/theme-aware-image.js"
|
|
197
|
-
},
|
|
198
162
|
"./components/mermaid": {
|
|
199
163
|
"types": "./dist/components/mermaid.d.ts",
|
|
200
164
|
"default": "./dist/components/mermaid.js"
|
|
@@ -211,74 +175,30 @@
|
|
|
211
175
|
"types": "./dist/components/scroll-area.d.ts",
|
|
212
176
|
"default": "./dist/components/scroll-area.js"
|
|
213
177
|
},
|
|
214
|
-
"./components/separator": {
|
|
215
|
-
"types": "./dist/components/separator.d.ts",
|
|
216
|
-
"default": "./dist/components/separator.js"
|
|
217
|
-
},
|
|
218
|
-
"./components/sheet": {
|
|
219
|
-
"types": "./dist/components/sheet.d.ts",
|
|
220
|
-
"default": "./dist/components/sheet.js"
|
|
221
|
-
},
|
|
222
|
-
"./components/sonner": {
|
|
223
|
-
"types": "./dist/components/sonner.d.ts",
|
|
224
|
-
"default": "./dist/components/sonner.js"
|
|
225
|
-
},
|
|
226
|
-
"./components/spinner": {
|
|
227
|
-
"types": "./dist/components/spinner.d.ts",
|
|
228
|
-
"default": "./dist/components/spinner.js"
|
|
229
|
-
},
|
|
230
|
-
"./components/switch": {
|
|
231
|
-
"types": "./dist/components/switch.d.ts",
|
|
232
|
-
"default": "./dist/components/switch.js"
|
|
233
|
-
},
|
|
234
|
-
"./components/theme-switcher": {
|
|
235
|
-
"types": "./dist/components/theme-switcher.d.ts",
|
|
236
|
-
"default": "./dist/components/theme-switcher.js"
|
|
237
|
-
},
|
|
238
|
-
"./components/textarea": {
|
|
239
|
-
"types": "./dist/components/textarea.d.ts",
|
|
240
|
-
"default": "./dist/components/textarea.js"
|
|
241
|
-
},
|
|
242
|
-
"./components/tooltip": {
|
|
243
|
-
"types": "./dist/components/tooltip.d.ts",
|
|
244
|
-
"default": "./dist/components/tooltip.js"
|
|
245
|
-
},
|
|
246
178
|
"./components/video": {
|
|
247
179
|
"types": "./dist/components/video.d.ts",
|
|
248
180
|
"default": "./dist/components/video.js"
|
|
249
181
|
},
|
|
250
|
-
"./assets/icons": {
|
|
251
|
-
"types": "./dist/assets/icons/index.d.ts",
|
|
252
|
-
"default": "./dist/assets/icons/index.js"
|
|
253
|
-
},
|
|
254
|
-
"./assets/icons/*": {
|
|
255
|
-
"types": "./dist/assets/icons/*.d.ts",
|
|
256
|
-
"default": "./dist/assets/icons/*.js"
|
|
257
|
-
},
|
|
258
|
-
"./assets/logos": {
|
|
259
|
-
"types": "./dist/assets/logos/index.d.ts",
|
|
260
|
-
"default": "./dist/assets/logos/index.js"
|
|
261
|
-
},
|
|
262
|
-
"./assets/logos/*": {
|
|
263
|
-
"types": "./dist/assets/logos/*.d.ts",
|
|
264
|
-
"default": "./dist/assets/logos/*.js"
|
|
265
|
-
},
|
|
266
182
|
"./styles.css": "./styles.css",
|
|
267
183
|
"./theme.css": "./theme.css",
|
|
268
184
|
"./package.json": "./package.json"
|
|
269
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
|
+
},
|
|
270
190
|
"dependencies": {
|
|
271
191
|
"@ai-sdk/react": "^3.0.134",
|
|
272
192
|
"@clack/prompts": "^0.11.0",
|
|
273
|
-
"@icons-pack/react-simple-icons": "^13.8.0",
|
|
274
193
|
"@orama/tokenizers": "^3.1.16",
|
|
275
194
|
"@streamdown/cjk": "^1.0.1",
|
|
276
195
|
"@streamdown/code": "^1.0.1",
|
|
277
196
|
"@vercel/agent-readability": "^0.6.0",
|
|
197
|
+
"@vercel/geistcn": "1.0.3",
|
|
198
|
+
"@vercel/geistcn-assets": "2.0.1",
|
|
278
199
|
"@vercel/oidc": "^3.4.1",
|
|
279
200
|
"ai": "^6.0.132",
|
|
280
201
|
"class-variance-authority": "^0.7.1",
|
|
281
|
-
"clsx": "^2.1.1",
|
|
282
202
|
"commander": "^14.0.2",
|
|
283
203
|
"dexie": "^4.2.1",
|
|
284
204
|
"dexie-react-hooks": "^4.2.0",
|
|
@@ -286,7 +206,6 @@
|
|
|
286
206
|
"fumadocs-mdx": "14.0.4",
|
|
287
207
|
"fumadocs-ui": "16.2.2",
|
|
288
208
|
"glob": "^11.0.0",
|
|
289
|
-
"lucide-react": "^0.555.0",
|
|
290
209
|
"mermaid": "^11.12.2",
|
|
291
210
|
"motion": "^12.23.25",
|
|
292
211
|
"next-themes": "^0.4.6",
|
|
@@ -296,19 +215,16 @@
|
|
|
296
215
|
"remark-gfm": "^4.0.1",
|
|
297
216
|
"remark-mdx": "^3.1.1",
|
|
298
217
|
"remark-parse": "^11.0.0",
|
|
299
|
-
"sonner": "^2.0.7",
|
|
300
218
|
"streamdown": "^2.1.0",
|
|
301
|
-
"tailwind-merge": "^3.4.0",
|
|
302
219
|
"ts-morph": "^27.0.2",
|
|
303
220
|
"tw-animate-css": "^1.4.0",
|
|
304
221
|
"unified": "^11.0.5",
|
|
305
222
|
"unist-util-visit": "^5.1.0",
|
|
306
223
|
"use-stick-to-bottom": "^1.1.1",
|
|
307
|
-
"vaul": "^1.1.2",
|
|
308
224
|
"zod": "^4.1.13"
|
|
309
225
|
},
|
|
310
226
|
"peerDependencies": {
|
|
311
|
-
"next": "^16.3.
|
|
227
|
+
"next": "^16.3.3",
|
|
312
228
|
"react": "^19.2.3",
|
|
313
229
|
"react-dom": "^19.2.3",
|
|
314
230
|
"tailwindcss": "^4.1.17"
|
|
@@ -322,14 +238,10 @@
|
|
|
322
238
|
"@types/react": "^19.2.7",
|
|
323
239
|
"@types/react-dom": "^19.2.3",
|
|
324
240
|
"mdast-util-mdx-jsx": "^3.2.0",
|
|
325
|
-
"next": "16.3.
|
|
241
|
+
"next": "16.3.3",
|
|
326
242
|
"react": "^19.2.3",
|
|
327
243
|
"react-dom": "^19.2.3",
|
|
328
244
|
"tsup": "^8.5.1",
|
|
329
245
|
"typescript": "^5.9.3"
|
|
330
|
-
},
|
|
331
|
-
"scripts": {
|
|
332
|
-
"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",
|
|
333
|
-
"dev": "tsc -p tsconfig.runtime.json --watch --preserveWatchOutput"
|
|
334
246
|
}
|
|
335
|
-
}
|
|
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
|
@@ -52,12 +52,14 @@ Use these instructions when an AI coding agent edits this project.
|
|
|
52
52
|
## Routing and proxy guidelines
|
|
53
53
|
|
|
54
54
|
- Keep App Router route files as thin adapters around package helpers such as `createDocsPage`, `createChatRoute`, `createLlmsRoute`, and `createProxy`.
|
|
55
|
+
- Keep `createGeistdocs` from `@vercel/geistdocs/next` as the `next.config.ts` wrapper. It composes Fumadocs MDX and generates the app-route manifest used by `createProxy`; do not replace it with `createMDX` directly.
|
|
55
56
|
- Keep `cacheComponents: true` and `partialPrefetching: true` in `next.config.ts`. Do not export `dynamic`, `revalidate`, or `fetchCache` from App Router pages or route handlers.
|
|
56
57
|
- Read `[lang]` from `next/root-params` in Server Components. Keep route context `params` in Route Handlers and Server Actions.
|
|
57
58
|
- Use `prefetch={true}` for app-owned links to fully static documentation pages so navigation does not stop at the generic route shell.
|
|
58
59
|
- Keep `export const config` in `proxy.ts` as a static object. Next.js must parse proxy matchers at build time.
|
|
59
60
|
- Use proxy matcher exclusions that only match `/api` and `/api/...`, such as `api(?:/|$)`. Do not exclude broad prefixes like `api`, because that also excludes routes such as `/api-reference`.
|
|
60
61
|
- Preserve markdown negotiation unless the task explicitly changes AI-readable output. Geistdocs serves `/agents.md`, `/llms.txt`, `/.well-known/mcp.json`, and per-page Markdown for `.md`, `.mdx`, `Accept: text/markdown`, and AI-agent requests.
|
|
62
|
+
- Restart `next dev` after adding, deleting, or renaming an App Router page or route so `createGeistdocs` regenerates its route manifest.
|
|
61
63
|
- When adding custom proxy behavior, prefer `before`, `after`, and `markdownRoutes` options on `createProxy` instead of replacing the proxy.
|
|
62
64
|
- Use explicit `markdownRoutes` for root-mounted docs or any site where homepage/app routes coexist with docs routes.
|
|
63
65
|
- Keep source URLs, navigation links, `getPageUrl`, and `markdownRoutes` app-local when `config.basePath` is set. Geistdocs derives public page-action and Markdown URLs separately.
|
|
@@ -107,3 +109,13 @@ Use these instructions when an AI coding agent edits this project.
|
|
|
107
109
|
- Run `pnpm dev` and open the changed pages when visual layout, navigation, or MDX rendering changes.
|
|
108
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.
|
|
109
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
|
);
|