@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
package/docs/llms.txt
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Geistdocs Package Documentation
|
|
2
2
|
|
|
3
|
-
These docs are bundled with `@vercel/geistdocs` 1.25.
|
|
3
|
+
These docs are bundled with `@vercel/geistdocs` 1.25.1-canary.47f1ad5.
|
|
4
4
|
They describe how to build package-backed Geistdocs sites and how to use the package APIs from generated project adapters.
|
|
5
5
|
|
|
6
6
|
## Documentation Index
|
|
@@ -26,7 +26,6 @@ They describe how to build package-backed Geistdocs sites and how to use the pac
|
|
|
26
26
|
- [Open in Chat](pages/open-in-chat.md): Transfer documentation context to AI chat platforms like ChatGPT, Claude, Cursor, and v0 with a single click.
|
|
27
27
|
- [RSS](pages/rss.md): An automatically generated RSS 2.0 feed that keeps users informed when documentation is published or updated.
|
|
28
28
|
- [Table of contents](pages/table-of-contents.md): 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.
|
|
29
|
-
- [Theme-Aware Image](pages/theme-aware-image.md): A component that swaps images based on the active theme, built on top of Next.js Image.
|
|
30
29
|
|
|
31
30
|
---
|
|
32
31
|
|
|
@@ -424,7 +423,7 @@ Fix unrelated build failures first. A migration is safer when the starting point
|
|
|
424
423
|
|
|
425
424
|
## Install Geistdocs
|
|
426
425
|
|
|
427
|
-
Add `@vercel/geistdocs` and align the supported Fumadocs and Next.js dependencies for the package version you are adopting.
|
|
426
|
+
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.
|
|
428
427
|
|
|
429
428
|
For an existing project, use your package manager directly:
|
|
430
429
|
|
|
@@ -757,16 +756,14 @@ For a base-path application whose root page is documentation, add `"/"` to the s
|
|
|
757
756
|
Tailwind CSS v4 requires `@source` entries for package components and related dependencies.
|
|
758
757
|
|
|
759
758
|
```css title="app/styles/geistdocs.css"
|
|
760
|
-
@import "
|
|
759
|
+
@import "@vercel/geistcn/tailwind.css";
|
|
760
|
+
@import "@vercel/geistcn/styles.css";
|
|
761
761
|
@import "fumadocs-ui/css/shadcn.css";
|
|
762
762
|
@import "fumadocs-ui/css/preset.css";
|
|
763
|
-
@import "
|
|
764
|
-
|
|
765
|
-
@source "../../node_modules/@vercel/geistdocs/dist/**/*.js";
|
|
766
|
-
@source "../../node_modules/streamdown/dist/*.js";
|
|
763
|
+
@import "@vercel/geistdocs/theme.css";
|
|
767
764
|
```
|
|
768
765
|
|
|
769
|
-
|
|
766
|
+
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.
|
|
770
767
|
|
|
771
768
|
## Handle environment variables
|
|
772
769
|
|
|
@@ -1205,7 +1202,9 @@ related:
|
|
|
1205
1202
|
|
|
1206
1203
|
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.
|
|
1207
1204
|
|
|
1208
|
-
Help me write a Geistdocs MDX page. Use this page as a syntax reference and
|
|
1205
|
+
Help me write a Geistdocs MDX page. Use this page as a syntax reference and
|
|
1206
|
+
create an example page with frontmatter, headings, links, a code block, a
|
|
1207
|
+
`Callout`, and a `CopyPrompt` component.
|
|
1209
1208
|
|
|
1210
1209
|
## Frontmatter
|
|
1211
1210
|
|
|
@@ -1257,11 +1256,17 @@ Headings automatically generate anchor links for navigation and deep linking.
|
|
|
1257
1256
|
|
|
1258
1257
|
Create unordered lists with `-`, `*`, or `+`:
|
|
1259
1258
|
|
|
1260
|
-
|
|
1261
|
-
-
|
|
1262
|
-
|
|
1263
|
-
|
|
1264
|
-
|
|
1259
|
+
```md
|
|
1260
|
+
- Install the required packages
|
|
1261
|
+
- Configure your project
|
|
1262
|
+
- Start the development server
|
|
1263
|
+
```
|
|
1264
|
+
|
|
1265
|
+
This renders as:
|
|
1266
|
+
|
|
1267
|
+
- Install the required packages
|
|
1268
|
+
- Configure your project
|
|
1269
|
+
- Start the development server
|
|
1265
1270
|
|
|
1266
1271
|
Create ordered lists with numbers:
|
|
1267
1272
|
|
|
@@ -1273,7 +1278,64 @@ Create ordered lists with numbers:
|
|
|
1273
1278
|
|
|
1274
1279
|
Use `>` to create blockquotes:
|
|
1275
1280
|
|
|
1276
|
-
>
|
|
1281
|
+
> **Watch:** Learn more about how to use `next/image` → [YouTube (9 minutes)](https://youtu.be/IU_qq_c_lKA).
|
|
1282
|
+
|
|
1283
|
+
### Callouts
|
|
1284
|
+
|
|
1285
|
+
Use `<Callout>` for a highlighted informational note:
|
|
1286
|
+
|
|
1287
|
+
```mdx
|
|
1288
|
+
<Callout>This is automatically set when deploying to Vercel.</Callout>
|
|
1289
|
+
```
|
|
1290
|
+
|
|
1291
|
+
This renders as:
|
|
1292
|
+
|
|
1293
|
+
> This is automatically set when deploying to Vercel.
|
|
1294
|
+
|
|
1295
|
+
Callouts can also contain a title and lists:
|
|
1296
|
+
|
|
1297
|
+
> Note:
|
|
1298
|
+
- The `App Router` uses [React canary
|
|
1299
|
+
releases](https://react.dev/blog/2023/05/03/react-canaries) built-in, which
|
|
1300
|
+
include all the stable React 19 changes, as well as newer features being
|
|
1301
|
+
validated in frameworks, but you should still declare react and react-dom in
|
|
1302
|
+
package.json for tooling and ecosystem compatibility.
|
|
1303
|
+
- The `Pages Router` uses the React version from your `package.json`.
|
|
1304
|
+
|
|
1305
|
+
### Copy Prompts
|
|
1306
|
+
|
|
1307
|
+
Short prompts render in full without an expansion control:
|
|
1308
|
+
|
|
1309
|
+
```mdx
|
|
1310
|
+
<CopyPrompt text="Summarize this documentation page and list the key concepts.">
|
|
1311
|
+
Summarize this documentation page and list the key concepts.
|
|
1312
|
+
</CopyPrompt>
|
|
1313
|
+
```
|
|
1314
|
+
|
|
1315
|
+
This renders as:
|
|
1316
|
+
|
|
1317
|
+
Summarize this documentation page and list the key concepts.
|
|
1318
|
+
|
|
1319
|
+
Long prompts initially show a preview with a **Show more** control:
|
|
1320
|
+
|
|
1321
|
+
```mdx
|
|
1322
|
+
<CopyPrompt collapsible text="Write a detailed migration plan for this project.">
|
|
1323
|
+
Write a detailed migration plan for this project. Include prerequisites,
|
|
1324
|
+
implementation steps, validation, rollback guidance, and common pitfalls.
|
|
1325
|
+
</CopyPrompt>
|
|
1326
|
+
```
|
|
1327
|
+
|
|
1328
|
+
Set the boolean `collapsible` prop when the prompt should initially render as a
|
|
1329
|
+
two-line preview. This renders as:
|
|
1330
|
+
|
|
1331
|
+
Review this Geistdocs project in detail. Explain how the `@vercel/geistdocs`
|
|
1332
|
+
package, application layouts, local adapter files, source configuration,
|
|
1333
|
+
`content/docs` directory, navigation metadata, MDX components, syntax
|
|
1334
|
+
highlighting, search routes, and deployment configuration work together.
|
|
1335
|
+
Then identify the safest first files to edit, describe the effect of each
|
|
1336
|
+
change, call out common mistakes, and propose a step-by-step plan for
|
|
1337
|
+
customizing the documentation site without breaking routing, generated
|
|
1338
|
+
Markdown, or accessibility behavior.
|
|
1277
1339
|
|
|
1278
1340
|
### Links
|
|
1279
1341
|
|
|
@@ -1282,6 +1344,26 @@ Create links with `[text](url)`:
|
|
|
1282
1344
|
- [External link](https://vercel.com)
|
|
1283
1345
|
- [Internal link](/docs/getting-started)
|
|
1284
1346
|
|
|
1347
|
+
Use an absolute `https://` or `http://` URL to mark a link as external. External
|
|
1348
|
+
links open outside the docs site and display an arrow icon. Use a root-relative
|
|
1349
|
+
path beginning with `/` for internal links:
|
|
1350
|
+
|
|
1351
|
+
```md
|
|
1352
|
+
[External link](https://vercel.com)
|
|
1353
|
+
[Internal link](/docs/getting-started)
|
|
1354
|
+
```
|
|
1355
|
+
|
|
1356
|
+
External links can also contain inline code. The underline applies to the text,
|
|
1357
|
+
but not the external-link icon:
|
|
1358
|
+
|
|
1359
|
+
```md
|
|
1360
|
+
Run independent requests in parallel with [`Promise.all`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise/all).
|
|
1361
|
+
```
|
|
1362
|
+
|
|
1363
|
+
This renders as:
|
|
1364
|
+
|
|
1365
|
+
Run independent requests in parallel with [`Promise.all`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise/all).
|
|
1366
|
+
|
|
1285
1367
|
### Images
|
|
1286
1368
|
|
|
1287
1369
|
Add images with ``:
|
|
@@ -1314,6 +1396,16 @@ This renders as:
|
|
|
1314
1396
|
| GFM | GitHub extensions | Supported |
|
|
1315
1397
|
| MDX | JSX in Markdown | Supported |
|
|
1316
1398
|
|
|
1399
|
+
Tables can also include inline code, as commonly used for file references:
|
|
1400
|
+
|
|
1401
|
+
| File | Description |
|
|
1402
|
+
| -------------------- | ------------------------------------------------ |
|
|
1403
|
+
| `next.config.js` | Configuration file for Next.js |
|
|
1404
|
+
| `package.json` | Project dependencies and scripts |
|
|
1405
|
+
| `instrumentation.ts` | OpenTelemetry and instrumentation file |
|
|
1406
|
+
| `.env.local` | Local environment variables |
|
|
1407
|
+
| `tsconfig.json` | Configuration file for TypeScript |
|
|
1408
|
+
|
|
1317
1409
|
### Task Lists
|
|
1318
1410
|
|
|
1319
1411
|
Create interactive task lists:
|
|
@@ -1386,6 +1478,78 @@ export const Button = ({ children }) => {
|
|
|
1386
1478
|
};
|
|
1387
1479
|
```
|
|
1388
1480
|
|
|
1481
|
+
### Tabs and switchers
|
|
1482
|
+
|
|
1483
|
+
Use consecutive fences with `tab` metadata for code tabs that expose every
|
|
1484
|
+
option at once:
|
|
1485
|
+
|
|
1486
|
+
````md
|
|
1487
|
+
```ts tab="TypeScript" title="example.ts"
|
|
1488
|
+
export const greeting: string = "Hello from TypeScript";
|
|
1489
|
+
```
|
|
1490
|
+
|
|
1491
|
+
```js tab="JavaScript" title="example.js"
|
|
1492
|
+
export const greeting = "Hello from JavaScript";
|
|
1493
|
+
```
|
|
1494
|
+
````
|
|
1495
|
+
|
|
1496
|
+
This renders as:
|
|
1497
|
+
|
|
1498
|
+
```ts tab="TypeScript" title="example.ts"
|
|
1499
|
+
export const greeting: string = "Hello from TypeScript";
|
|
1500
|
+
```
|
|
1501
|
+
|
|
1502
|
+
```js tab="JavaScript" title="example.js"
|
|
1503
|
+
export const greeting = "Hello from JavaScript";
|
|
1504
|
+
```
|
|
1505
|
+
|
|
1506
|
+
Wrap the same fences in `<CodeBlockTabs compact>` to move the selector into the
|
|
1507
|
+
code-block header:
|
|
1508
|
+
|
|
1509
|
+
````mdx
|
|
1510
|
+
<CompactCodeBlockTabs defaultValue="TypeScript">
|
|
1511
|
+
<CodeBlockTabsList>
|
|
1512
|
+
<CodeBlockTabsTrigger value="TypeScript">TypeScript</CodeBlockTabsTrigger>
|
|
1513
|
+
<CodeBlockTabsTrigger value="JavaScript">JavaScript</CodeBlockTabsTrigger>
|
|
1514
|
+
</CodeBlockTabsList>
|
|
1515
|
+
<CodeBlockTab value="TypeScript">
|
|
1516
|
+
```ts title="example.ts"
|
|
1517
|
+
export const greeting: string = "Hello from TypeScript";
|
|
1518
|
+
```
|
|
1519
|
+
</CodeBlockTab>
|
|
1520
|
+
<CodeBlockTab value="JavaScript">
|
|
1521
|
+
```js title="example.js"
|
|
1522
|
+
export const greeting = "Hello from JavaScript";
|
|
1523
|
+
```
|
|
1524
|
+
</CodeBlockTab>
|
|
1525
|
+
</CompactCodeBlockTabs>
|
|
1526
|
+
````
|
|
1527
|
+
|
|
1528
|
+
This renders as:
|
|
1529
|
+
|
|
1530
|
+
<CompactCodeBlockTabs defaultValue="TypeScript">
|
|
1531
|
+
<CodeBlockTabsList>
|
|
1532
|
+
<CodeBlockTabsTrigger value="TypeScript">TypeScript</CodeBlockTabsTrigger>
|
|
1533
|
+
<CodeBlockTabsTrigger value="JavaScript">JavaScript</CodeBlockTabsTrigger>
|
|
1534
|
+
</CodeBlockTabsList>
|
|
1535
|
+
<CodeBlockTab value="TypeScript">
|
|
1536
|
+
```ts title="example.ts"
|
|
1537
|
+
export const greeting: string = "Hello from TypeScript";
|
|
1538
|
+
```
|
|
1539
|
+
</CodeBlockTab>
|
|
1540
|
+
<CodeBlockTab value="JavaScript">
|
|
1541
|
+
```js title="example.js"
|
|
1542
|
+
export const greeting = "Hello from JavaScript";
|
|
1543
|
+
```
|
|
1544
|
+
</CodeBlockTab>
|
|
1545
|
+
</CompactCodeBlockTabs>
|
|
1546
|
+
|
|
1547
|
+
When migrating an existing site such as next-site, translate adjacent
|
|
1548
|
+
`switcher` fences to `tab="TypeScript"` and `tab="JavaScript"`, then wrap the
|
|
1549
|
+
pair with `<CodeBlockTabs compact>`. Import `@vercel/geistdocs/styles.css` (or
|
|
1550
|
+
`theme.css` with the documented Geist dependencies) so Tailwind scans the
|
|
1551
|
+
package's compiled components and emits the tab layout utilities.
|
|
1552
|
+
|
|
1389
1553
|
### Framework icons
|
|
1390
1554
|
|
|
1391
1555
|
Append `#<framework>` to the title to show a framework logo instead of the
|
|
@@ -1394,22 +1558,22 @@ values are `#next` / `#nextjs` and `#svelte` / `#sveltekit`:
|
|
|
1394
1558
|
|
|
1395
1559
|
````md
|
|
1396
1560
|
```ts title="flags.ts#next"
|
|
1397
|
-
import { flag } from
|
|
1561
|
+
import { flag } from "flags/next";
|
|
1398
1562
|
```
|
|
1399
1563
|
|
|
1400
1564
|
```ts title="flags.ts#svelte"
|
|
1401
|
-
import { flag } from
|
|
1565
|
+
import { flag } from "flags/sveltekit";
|
|
1402
1566
|
```
|
|
1403
1567
|
````
|
|
1404
1568
|
|
|
1405
1569
|
This renders as:
|
|
1406
1570
|
|
|
1407
1571
|
```ts title="flags.ts#next"
|
|
1408
|
-
import { flag } from
|
|
1572
|
+
import { flag } from "flags/next";
|
|
1409
1573
|
```
|
|
1410
1574
|
|
|
1411
1575
|
```ts title="flags.ts#svelte"
|
|
1412
|
-
import { flag } from
|
|
1576
|
+
import { flag } from "flags/sveltekit";
|
|
1413
1577
|
```
|
|
1414
1578
|
|
|
1415
1579
|
### Line Numbers
|
|
@@ -1898,7 +2062,7 @@ Each version can define an `icon` to override the default current/previous versi
|
|
|
1898
2062
|
Use `GeistdocsRouteSelect` for framework, product, or route switchers that should not use version-specific labels:
|
|
1899
2063
|
|
|
1900
2064
|
```tsx
|
|
1901
|
-
import {
|
|
2065
|
+
import { LogoIconNextSvg, LogoSvelte } from "@vercel/geistcn-assets/logos";
|
|
1902
2066
|
import { GeistdocsRouteSelect } from "@vercel/geistdocs/versions";
|
|
1903
2067
|
|
|
1904
2068
|
<GeistdocsRouteSelect
|
|
@@ -1909,14 +2073,14 @@ import { GeistdocsRouteSelect } from "@vercel/geistdocs/versions";
|
|
|
1909
2073
|
id: "nextjs",
|
|
1910
2074
|
label: "Next.js",
|
|
1911
2075
|
description: "React framework",
|
|
1912
|
-
icon: <
|
|
2076
|
+
icon: <LogoIconNextSvg size={18} />,
|
|
1913
2077
|
href: "/:path*",
|
|
1914
2078
|
},
|
|
1915
2079
|
{
|
|
1916
2080
|
id: "sveltekit",
|
|
1917
2081
|
label: "SvelteKit",
|
|
1918
2082
|
description: "Svelte framework",
|
|
1919
|
-
icon: <
|
|
2083
|
+
icon: <LogoSvelte height={18} />,
|
|
1920
2084
|
routePrefix: "/sveltekit",
|
|
1921
2085
|
href: "/sveltekit/:path*",
|
|
1922
2086
|
},
|
|
@@ -3607,66 +3771,3 @@ On mobile, Geistdocs replaces the sidebar outline with a compact menu in the pag
|
|
|
3607
3771
|
|
|
3608
3772
|
Keep headings short and descriptive so the outline reads like a summary of the page. Name each heading after the goal of its section, and avoid stacking two headings with no content between them.
|
|
3609
3773
|
|
|
3610
|
-
|
|
3611
|
-
---
|
|
3612
|
-
|
|
3613
|
-
---
|
|
3614
|
-
title: Theme-Aware Image
|
|
3615
|
-
description: Display different images based on the user's light or dark theme preference
|
|
3616
|
-
type: reference
|
|
3617
|
-
summary: A component that swaps images based on the active theme, built on top of Next.js Image.
|
|
3618
|
-
url: /docs/theme-aware-image
|
|
3619
|
-
source: apps/template/content/docs/theme-aware-image.mdx
|
|
3620
|
-
prerequisites:
|
|
3621
|
-
- /docs/getting-started
|
|
3622
|
-
- /docs/provider
|
|
3623
|
-
related:
|
|
3624
|
-
- /docs/syntax
|
|
3625
|
-
- /docs/configuration
|
|
3626
|
-
---
|
|
3627
|
-
|
|
3628
|
-
# Theme-Aware Image
|
|
3629
|
-
|
|
3630
|
-
The `ThemeAwareImage` component renders different images depending on whether the user is viewing your documentation in light or dark mode. It extends the Next.js `Image` component, so you get all the same optimization benefits like lazy loading, responsive sizing, and format conversion.
|
|
3631
|
-
|
|
3632
|
-
Help me add a theme-aware image to a Geistdocs MDX page. Create a usage example with light and dark image sources, alt text, width, and height, then explain where to place the image files.
|
|
3633
|
-
|
|
3634
|
-
## Usage
|
|
3635
|
-
|
|
3636
|
-
Import the component and pass a `src` object with `light` and `dark` variants:
|
|
3637
|
-
|
|
3638
|
-
```tsx
|
|
3639
|
-
import { ThemeAwareImage } from "@vercel/geistdocs/components/theme-aware-image";
|
|
3640
|
-
|
|
3641
|
-
<ThemeAwareImage
|
|
3642
|
-
src={{
|
|
3643
|
-
light: "/images/diagram-light.png",
|
|
3644
|
-
dark: "/images/diagram-dark.png",
|
|
3645
|
-
}}
|
|
3646
|
-
alt="Architecture diagram"
|
|
3647
|
-
width={800}
|
|
3648
|
-
height={400}
|
|
3649
|
-
/>
|
|
3650
|
-
```
|
|
3651
|
-
|
|
3652
|
-
The component reads the current theme from `next-themes` and resolves the correct image source automatically. All standard Next.js `Image` props (such as `width`, `height`, `alt`, `priority`, and `className`) are supported.
|
|
3653
|
-
|
|
3654
|
-
## How it works
|
|
3655
|
-
|
|
3656
|
-
`ThemeAwareImage` uses the `resolvedTheme` value from the `useTheme` hook provided by `next-themes`. This ensures it responds to the actual rendered theme, even when the user's preference is set to "system".
|
|
3657
|
-
|
|
3658
|
-
- When `resolvedTheme` is `"dark"`, the `src.dark` image is displayed.
|
|
3659
|
-
- Otherwise, the `src.light` image is used.
|
|
3660
|
-
|
|
3661
|
-
Because this component relies on client-side theme detection, it is a client component (`"use client"`).
|
|
3662
|
-
|
|
3663
|
-
## Props
|
|
3664
|
-
|
|
3665
|
-
| Prop | Type | Description |
|
|
3666
|
-
| --- | --- | --- |
|
|
3667
|
-
| `src` | `{ light: ImageProps["src"]; dark: ImageProps["src"] }` | An object containing the light and dark image sources |
|
|
3668
|
-
| `alt` | `string` | Accessible alt text for the image |
|
|
3669
|
-
| `width` | `number` | The width of the image in pixels |
|
|
3670
|
-
| `height` | `number` | The height of the image in pixels |
|
|
3671
|
-
| `...rest` | `ImageProps` | Any additional props supported by the Next.js `Image` component |
|
|
3672
|
-
|
package/docs/manifest.json
CHANGED
|
@@ -196,17 +196,8 @@
|
|
|
196
196
|
"title": "Table of contents",
|
|
197
197
|
"type": "reference",
|
|
198
198
|
"url": "/docs/table-of-contents"
|
|
199
|
-
},
|
|
200
|
-
{
|
|
201
|
-
"description": "Display different images based on the user's light or dark theme preference",
|
|
202
|
-
"path": "pages/theme-aware-image.md",
|
|
203
|
-
"source": "apps/template/content/docs/theme-aware-image.mdx",
|
|
204
|
-
"summary": "A component that swaps images based on the active theme, built on top of Next.js Image.",
|
|
205
|
-
"title": "Theme-Aware Image",
|
|
206
|
-
"type": "reference",
|
|
207
|
-
"url": "/docs/theme-aware-image"
|
|
208
199
|
}
|
|
209
200
|
],
|
|
210
201
|
"source": "apps/template/content/docs",
|
|
211
|
-
"version": "1.25.
|
|
202
|
+
"version": "1.25.1-canary.47f1ad5"
|
|
212
203
|
}
|
package/docs/pages/migration.md
CHANGED
|
@@ -44,7 +44,7 @@ Fix unrelated build failures first. A migration is safer when the starting point
|
|
|
44
44
|
|
|
45
45
|
## Install Geistdocs
|
|
46
46
|
|
|
47
|
-
Add `@vercel/geistdocs` and align the supported Fumadocs and Next.js dependencies for the package version you are adopting.
|
|
47
|
+
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.
|
|
48
48
|
|
|
49
49
|
For an existing project, use your package manager directly:
|
|
50
50
|
|
|
@@ -377,16 +377,14 @@ For a base-path application whose root page is documentation, add `"/"` to the s
|
|
|
377
377
|
Tailwind CSS v4 requires `@source` entries for package components and related dependencies.
|
|
378
378
|
|
|
379
379
|
```css title="app/styles/geistdocs.css"
|
|
380
|
-
@import "
|
|
380
|
+
@import "@vercel/geistcn/tailwind.css";
|
|
381
|
+
@import "@vercel/geistcn/styles.css";
|
|
381
382
|
@import "fumadocs-ui/css/shadcn.css";
|
|
382
383
|
@import "fumadocs-ui/css/preset.css";
|
|
383
|
-
@import "
|
|
384
|
-
|
|
385
|
-
@source "../../node_modules/@vercel/geistdocs/dist/**/*.js";
|
|
386
|
-
@source "../../node_modules/streamdown/dist/*.js";
|
|
384
|
+
@import "@vercel/geistdocs/theme.css";
|
|
387
385
|
```
|
|
388
386
|
|
|
389
|
-
|
|
387
|
+
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.
|
|
390
388
|
|
|
391
389
|
## Handle environment variables
|
|
392
390
|
|
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,64 @@ 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.
|
|
107
|
+
|
|
108
|
+
Callouts can also contain a title and lists:
|
|
109
|
+
|
|
110
|
+
> Note:
|
|
111
|
+
- The `App Router` uses [React canary
|
|
112
|
+
releases](https://react.dev/blog/2023/05/03/react-canaries) built-in, which
|
|
113
|
+
include all the stable React 19 changes, as well as newer features being
|
|
114
|
+
validated in frameworks, but you should still declare react and react-dom in
|
|
115
|
+
package.json for tooling and ecosystem compatibility.
|
|
116
|
+
- The `Pages Router` uses the React version from your `package.json`.
|
|
117
|
+
|
|
118
|
+
### Copy Prompts
|
|
119
|
+
|
|
120
|
+
Short prompts render in full without an expansion control:
|
|
121
|
+
|
|
122
|
+
```mdx
|
|
123
|
+
<CopyPrompt text="Summarize this documentation page and list the key concepts.">
|
|
124
|
+
Summarize this documentation page and list the key concepts.
|
|
125
|
+
</CopyPrompt>
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
This renders as:
|
|
129
|
+
|
|
130
|
+
Summarize this documentation page and list the key concepts.
|
|
131
|
+
|
|
132
|
+
Long prompts initially show a preview with a **Show more** control:
|
|
133
|
+
|
|
134
|
+
```mdx
|
|
135
|
+
<CopyPrompt collapsible text="Write a detailed migration plan for this project.">
|
|
136
|
+
Write a detailed migration plan for this project. Include prerequisites,
|
|
137
|
+
implementation steps, validation, rollback guidance, and common pitfalls.
|
|
138
|
+
</CopyPrompt>
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
Set the boolean `collapsible` prop when the prompt should initially render as a
|
|
142
|
+
two-line preview. This renders as:
|
|
143
|
+
|
|
144
|
+
Review this Geistdocs project in detail. Explain how the `@vercel/geistdocs`
|
|
145
|
+
package, application layouts, local adapter files, source configuration,
|
|
146
|
+
`content/docs` directory, navigation metadata, MDX components, syntax
|
|
147
|
+
highlighting, search routes, and deployment configuration work together.
|
|
148
|
+
Then identify the safest first files to edit, describe the effect of each
|
|
149
|
+
change, call out common mistakes, and propose a step-by-step plan for
|
|
150
|
+
customizing the documentation site without breaking routing, generated
|
|
151
|
+
Markdown, or accessibility behavior.
|
|
87
152
|
|
|
88
153
|
### Links
|
|
89
154
|
|
|
@@ -92,6 +157,26 @@ Create links with `[text](url)`:
|
|
|
92
157
|
- [External link](https://vercel.com)
|
|
93
158
|
- [Internal link](/docs/getting-started)
|
|
94
159
|
|
|
160
|
+
Use an absolute `https://` or `http://` URL to mark a link as external. External
|
|
161
|
+
links open outside the docs site and display an arrow icon. Use a root-relative
|
|
162
|
+
path beginning with `/` for internal links:
|
|
163
|
+
|
|
164
|
+
```md
|
|
165
|
+
[External link](https://vercel.com)
|
|
166
|
+
[Internal link](/docs/getting-started)
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
External links can also contain inline code. The underline applies to the text,
|
|
170
|
+
but not the external-link icon:
|
|
171
|
+
|
|
172
|
+
```md
|
|
173
|
+
Run independent requests in parallel with [`Promise.all`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise/all).
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
This renders as:
|
|
177
|
+
|
|
178
|
+
Run independent requests in parallel with [`Promise.all`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise/all).
|
|
179
|
+
|
|
95
180
|
### Images
|
|
96
181
|
|
|
97
182
|
Add images with ``:
|
|
@@ -124,6 +209,16 @@ This renders as:
|
|
|
124
209
|
| GFM | GitHub extensions | Supported |
|
|
125
210
|
| MDX | JSX in Markdown | Supported |
|
|
126
211
|
|
|
212
|
+
Tables can also include inline code, as commonly used for file references:
|
|
213
|
+
|
|
214
|
+
| File | Description |
|
|
215
|
+
| -------------------- | ------------------------------------------------ |
|
|
216
|
+
| `next.config.js` | Configuration file for Next.js |
|
|
217
|
+
| `package.json` | Project dependencies and scripts |
|
|
218
|
+
| `instrumentation.ts` | OpenTelemetry and instrumentation file |
|
|
219
|
+
| `.env.local` | Local environment variables |
|
|
220
|
+
| `tsconfig.json` | Configuration file for TypeScript |
|
|
221
|
+
|
|
127
222
|
### Task Lists
|
|
128
223
|
|
|
129
224
|
Create interactive task lists:
|
|
@@ -196,6 +291,78 @@ export const Button = ({ children }) => {
|
|
|
196
291
|
};
|
|
197
292
|
```
|
|
198
293
|
|
|
294
|
+
### Tabs and switchers
|
|
295
|
+
|
|
296
|
+
Use consecutive fences with `tab` metadata for code tabs that expose every
|
|
297
|
+
option at once:
|
|
298
|
+
|
|
299
|
+
````md
|
|
300
|
+
```ts tab="TypeScript" title="example.ts"
|
|
301
|
+
export const greeting: string = "Hello from TypeScript";
|
|
302
|
+
```
|
|
303
|
+
|
|
304
|
+
```js tab="JavaScript" title="example.js"
|
|
305
|
+
export const greeting = "Hello from JavaScript";
|
|
306
|
+
```
|
|
307
|
+
````
|
|
308
|
+
|
|
309
|
+
This renders as:
|
|
310
|
+
|
|
311
|
+
```ts tab="TypeScript" title="example.ts"
|
|
312
|
+
export const greeting: string = "Hello from TypeScript";
|
|
313
|
+
```
|
|
314
|
+
|
|
315
|
+
```js tab="JavaScript" title="example.js"
|
|
316
|
+
export const greeting = "Hello from JavaScript";
|
|
317
|
+
```
|
|
318
|
+
|
|
319
|
+
Wrap the same fences in `<CodeBlockTabs compact>` to move the selector into the
|
|
320
|
+
code-block header:
|
|
321
|
+
|
|
322
|
+
````mdx
|
|
323
|
+
<CompactCodeBlockTabs defaultValue="TypeScript">
|
|
324
|
+
<CodeBlockTabsList>
|
|
325
|
+
<CodeBlockTabsTrigger value="TypeScript">TypeScript</CodeBlockTabsTrigger>
|
|
326
|
+
<CodeBlockTabsTrigger value="JavaScript">JavaScript</CodeBlockTabsTrigger>
|
|
327
|
+
</CodeBlockTabsList>
|
|
328
|
+
<CodeBlockTab value="TypeScript">
|
|
329
|
+
```ts title="example.ts"
|
|
330
|
+
export const greeting: string = "Hello from TypeScript";
|
|
331
|
+
```
|
|
332
|
+
</CodeBlockTab>
|
|
333
|
+
<CodeBlockTab value="JavaScript">
|
|
334
|
+
```js title="example.js"
|
|
335
|
+
export const greeting = "Hello from JavaScript";
|
|
336
|
+
```
|
|
337
|
+
</CodeBlockTab>
|
|
338
|
+
</CompactCodeBlockTabs>
|
|
339
|
+
````
|
|
340
|
+
|
|
341
|
+
This renders as:
|
|
342
|
+
|
|
343
|
+
<CompactCodeBlockTabs defaultValue="TypeScript">
|
|
344
|
+
<CodeBlockTabsList>
|
|
345
|
+
<CodeBlockTabsTrigger value="TypeScript">TypeScript</CodeBlockTabsTrigger>
|
|
346
|
+
<CodeBlockTabsTrigger value="JavaScript">JavaScript</CodeBlockTabsTrigger>
|
|
347
|
+
</CodeBlockTabsList>
|
|
348
|
+
<CodeBlockTab value="TypeScript">
|
|
349
|
+
```ts title="example.ts"
|
|
350
|
+
export const greeting: string = "Hello from TypeScript";
|
|
351
|
+
```
|
|
352
|
+
</CodeBlockTab>
|
|
353
|
+
<CodeBlockTab value="JavaScript">
|
|
354
|
+
```js title="example.js"
|
|
355
|
+
export const greeting = "Hello from JavaScript";
|
|
356
|
+
```
|
|
357
|
+
</CodeBlockTab>
|
|
358
|
+
</CompactCodeBlockTabs>
|
|
359
|
+
|
|
360
|
+
When migrating an existing site such as next-site, translate adjacent
|
|
361
|
+
`switcher` fences to `tab="TypeScript"` and `tab="JavaScript"`, then wrap the
|
|
362
|
+
pair with `<CodeBlockTabs compact>`. Import `@vercel/geistdocs/styles.css` (or
|
|
363
|
+
`theme.css` with the documented Geist dependencies) so Tailwind scans the
|
|
364
|
+
package's compiled components and emits the tab layout utilities.
|
|
365
|
+
|
|
199
366
|
### Framework icons
|
|
200
367
|
|
|
201
368
|
Append `#<framework>` to the title to show a framework logo instead of the
|
|
@@ -204,22 +371,22 @@ values are `#next` / `#nextjs` and `#svelte` / `#sveltekit`:
|
|
|
204
371
|
|
|
205
372
|
````md
|
|
206
373
|
```ts title="flags.ts#next"
|
|
207
|
-
import { flag } from
|
|
374
|
+
import { flag } from "flags/next";
|
|
208
375
|
```
|
|
209
376
|
|
|
210
377
|
```ts title="flags.ts#svelte"
|
|
211
|
-
import { flag } from
|
|
378
|
+
import { flag } from "flags/sveltekit";
|
|
212
379
|
```
|
|
213
380
|
````
|
|
214
381
|
|
|
215
382
|
This renders as:
|
|
216
383
|
|
|
217
384
|
```ts title="flags.ts#next"
|
|
218
|
-
import { flag } from
|
|
385
|
+
import { flag } from "flags/next";
|
|
219
386
|
```
|
|
220
387
|
|
|
221
388
|
```ts title="flags.ts#svelte"
|
|
222
|
-
import { flag } from
|
|
389
|
+
import { flag } from "flags/sveltekit";
|
|
223
390
|
```
|
|
224
391
|
|
|
225
392
|
### Line Numbers
|