@vercel/geistdocs 1.25.0 → 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/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/pages/docs.d.ts.map +1 -1
- package/dist/pages/docs.js +8 -3
- package/dist/source.d.ts.map +1 -1
- package/dist/source.js +0 -2
- package/dist/versions.d.ts.map +1 -1
- package/dist/versions.js +5 -5
- package/docs/agents.md +1 -2
- package/docs/llms.txt +187 -86
- package/docs/manifest.json +1 -10
- package/docs/pages/migration.md +5 -7
- package/docs/pages/syntax.md +178 -11
- package/docs/pages/versioned-docs.md +3 -3
- package/docs/sitemap.md +0 -1
- package/package.json +11 -102
- package/styles.css +3 -2
- package/template/AGENTS.md +10 -0
- package/template/app/[lang]/(home)/components/hero.tsx +2 -2
- package/template/app/[lang]/(home)/components/one-two-section.tsx +9 -1
- package/template/app/[lang]/(home)/components/text-grid-section.tsx +1 -1
- package/template/app/[lang]/(home)/page.tsx +5 -6
- package/template/app/[lang]/layout.tsx +11 -4
- 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/migration.mdx +5 -7
- 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 +16 -2
- 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
|
@@ -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
|
},
|
package/template/next.config.ts
CHANGED
|
@@ -13,7 +13,6 @@ const withGeistdocs = createGeistdocs();
|
|
|
13
13
|
const inMonorepo = existsSync(
|
|
14
14
|
join(process.cwd(), "../../packages/geistdocs/src")
|
|
15
15
|
);
|
|
16
|
-
|
|
17
16
|
// Distinct favicon per environment; production keeps the default (no-op).
|
|
18
17
|
const ENV_FAVICONS = {
|
|
19
18
|
development: "/favicon.development.ico",
|
|
@@ -24,7 +23,22 @@ const environment = process.env.VERCEL_ENV ?? process.env.NODE_ENV;
|
|
|
24
23
|
const envFavicon = ENV_FAVICONS[environment as keyof typeof ENV_FAVICONS];
|
|
25
24
|
|
|
26
25
|
const config: NextConfig = {
|
|
27
|
-
|
|
26
|
+
modularizeImports: {
|
|
27
|
+
"@vercel/geistcn/components": {
|
|
28
|
+
skipDefaultConversion: true,
|
|
29
|
+
transform: "@vercel/geistcn/components/{{ kebabCase member }}",
|
|
30
|
+
},
|
|
31
|
+
"@vercel/geistcn/core": {
|
|
32
|
+
skipDefaultConversion: true,
|
|
33
|
+
transform: "@vercel/geistcn/core",
|
|
34
|
+
},
|
|
35
|
+
},
|
|
36
|
+
transpilePackages: [
|
|
37
|
+
"@vercel/geistcn",
|
|
38
|
+
"@vercel/geist-test-utils",
|
|
39
|
+
"@vercel/next-themes",
|
|
40
|
+
...(inMonorepo ? ["@vercel/geistdocs"] : []),
|
|
41
|
+
],
|
|
28
42
|
cacheComponents: true,
|
|
29
43
|
partialPrefetching: true,
|
|
30
44
|
|
package/template/package.json
CHANGED
|
@@ -12,13 +12,14 @@
|
|
|
12
12
|
},
|
|
13
13
|
"dependencies": {
|
|
14
14
|
"@ai-sdk/react": "^3.0.134",
|
|
15
|
-
"@icons-pack/react-simple-icons": "^13.8.0",
|
|
16
15
|
"@orama/tokenizers": "^3.1.16",
|
|
17
16
|
"@streamdown/cjk": "^1.0.1",
|
|
18
17
|
"@streamdown/code": "^1.0.1",
|
|
19
18
|
"@vercel/agent-readability": "^0.6.0",
|
|
20
19
|
"@vercel/analytics": "^1.6.1",
|
|
21
|
-
"@vercel/
|
|
20
|
+
"@vercel/geistcn": "1.0.3",
|
|
21
|
+
"@vercel/geistcn-assets": "2.0.1",
|
|
22
|
+
"@vercel/geistdocs": "1.25.1-canary.47f1ad5",
|
|
22
23
|
"@vercel/speed-insights": "^1.3.1",
|
|
23
24
|
"ai": "^6.0.132",
|
|
24
25
|
"class-variance-authority": "^0.7.1",
|
|
@@ -30,24 +31,21 @@
|
|
|
30
31
|
"fumadocs-core": "16.2.2",
|
|
31
32
|
"fumadocs-mdx": "14.0.4",
|
|
32
33
|
"fumadocs-ui": "16.2.2",
|
|
33
|
-
"geist": "
|
|
34
|
+
"geist": "1.7.1",
|
|
34
35
|
"jotai": "^2.15.2",
|
|
35
|
-
"lucide-react": "^0.555.0",
|
|
36
36
|
"mermaid": "^11.12.2",
|
|
37
37
|
"motion": "^12.23.25",
|
|
38
38
|
"nanoid": "^5.1.6",
|
|
39
|
-
"next": "16.3.
|
|
39
|
+
"next": "16.3.3",
|
|
40
40
|
"next-themes": "^0.4.6",
|
|
41
41
|
"radix-ui": "1.6.4",
|
|
42
42
|
"react": "^19.2.3",
|
|
43
43
|
"react-dom": "^19.2.3",
|
|
44
44
|
"react-player": "^3.4.0",
|
|
45
45
|
"shiki": "3.19.0",
|
|
46
|
-
"sonner": "^2.0.7",
|
|
47
46
|
"streamdown": "^2.1.0",
|
|
48
47
|
"tailwind-merge": "^3.4.0",
|
|
49
48
|
"use-stick-to-bottom": "^1.1.1",
|
|
50
|
-
"vaul": "^1.1.2",
|
|
51
49
|
"zod": "^4.1.13"
|
|
52
50
|
},
|
|
53
51
|
"devDependencies": {
|