@vercel/geistdocs 1.25.0 → 1.25.1-canary.738f050
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/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/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 +131 -86
- package/docs/manifest.json +1 -10
- package/docs/pages/migration.md +5 -7
- package/docs/pages/syntax.md +122 -11
- package/docs/pages/versioned-docs.md +3 -3
- package/docs/sitemap.md +0 -1
- package/package.json +10 -102
- package/styles.css +3 -2
- package/template/AGENTS.md +10 -0
- package/template/app/[lang]/(home)/components/hero.tsx +2 -2
- package/template/app/[lang]/(home)/components/one-two-section.tsx +9 -1
- package/template/app/[lang]/(home)/components/text-grid-section.tsx +1 -1
- package/template/app/[lang]/(home)/page.tsx +5 -6
- package/template/app/[lang]/layout.tsx +7 -4
- package/template/app/styles/geistdocs.css +17 -14
- package/template/content/docs/configuration.cn.mdx +2 -2
- package/template/content/docs/migration.mdx +5 -7
- package/template/content/docs/syntax.mdx +123 -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 +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
|
@@ -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,30 @@ 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>
|
|
85
116
|
|
|
86
117
|
### Links
|
|
87
118
|
|
|
@@ -90,6 +121,15 @@ Create links with `[text](url)`:
|
|
|
90
121
|
- [External link](https://vercel.com)
|
|
91
122
|
- [Internal link](/docs/getting-started)
|
|
92
123
|
|
|
124
|
+
Use an absolute `https://` or `http://` URL to mark a link as external. External
|
|
125
|
+
links open outside the docs site and display an arrow icon. Use a root-relative
|
|
126
|
+
path beginning with `/` for internal links:
|
|
127
|
+
|
|
128
|
+
```md
|
|
129
|
+
[External link](https://vercel.com)
|
|
130
|
+
[Internal link](/docs/getting-started)
|
|
131
|
+
```
|
|
132
|
+
|
|
93
133
|
### Images
|
|
94
134
|
|
|
95
135
|
Add images with ``:
|
|
@@ -194,6 +234,78 @@ export const Button = ({ children }) => {
|
|
|
194
234
|
};
|
|
195
235
|
```
|
|
196
236
|
|
|
237
|
+
### Tabs and switchers
|
|
238
|
+
|
|
239
|
+
Use consecutive fences with `tab` metadata for code tabs that expose every
|
|
240
|
+
option at once:
|
|
241
|
+
|
|
242
|
+
````md
|
|
243
|
+
```ts tab="TypeScript" title="example.ts"
|
|
244
|
+
export const greeting: string = "Hello from TypeScript";
|
|
245
|
+
```
|
|
246
|
+
|
|
247
|
+
```js tab="JavaScript" title="example.js"
|
|
248
|
+
export const greeting = "Hello from JavaScript";
|
|
249
|
+
```
|
|
250
|
+
````
|
|
251
|
+
|
|
252
|
+
This renders as:
|
|
253
|
+
|
|
254
|
+
```ts tab="TypeScript" title="example.ts"
|
|
255
|
+
export const greeting: string = "Hello from TypeScript";
|
|
256
|
+
```
|
|
257
|
+
|
|
258
|
+
```js tab="JavaScript" title="example.js"
|
|
259
|
+
export const greeting = "Hello from JavaScript";
|
|
260
|
+
```
|
|
261
|
+
|
|
262
|
+
Wrap the same fences in `<CodeBlockTabs compact>` to move the selector into the
|
|
263
|
+
code-block header:
|
|
264
|
+
|
|
265
|
+
````mdx
|
|
266
|
+
<CompactCodeBlockTabs defaultValue="TypeScript">
|
|
267
|
+
<CodeBlockTabsList>
|
|
268
|
+
<CodeBlockTabsTrigger value="TypeScript">TypeScript</CodeBlockTabsTrigger>
|
|
269
|
+
<CodeBlockTabsTrigger value="JavaScript">JavaScript</CodeBlockTabsTrigger>
|
|
270
|
+
</CodeBlockTabsList>
|
|
271
|
+
<CodeBlockTab value="TypeScript">
|
|
272
|
+
```ts title="example.ts"
|
|
273
|
+
export const greeting: string = "Hello from TypeScript";
|
|
274
|
+
```
|
|
275
|
+
</CodeBlockTab>
|
|
276
|
+
<CodeBlockTab value="JavaScript">
|
|
277
|
+
```js title="example.js"
|
|
278
|
+
export const greeting = "Hello from JavaScript";
|
|
279
|
+
```
|
|
280
|
+
</CodeBlockTab>
|
|
281
|
+
</CompactCodeBlockTabs>
|
|
282
|
+
````
|
|
283
|
+
|
|
284
|
+
This renders as:
|
|
285
|
+
|
|
286
|
+
<CompactCodeBlockTabs defaultValue="TypeScript">
|
|
287
|
+
<CodeBlockTabsList>
|
|
288
|
+
<CodeBlockTabsTrigger value="TypeScript">TypeScript</CodeBlockTabsTrigger>
|
|
289
|
+
<CodeBlockTabsTrigger value="JavaScript">JavaScript</CodeBlockTabsTrigger>
|
|
290
|
+
</CodeBlockTabsList>
|
|
291
|
+
<CodeBlockTab value="TypeScript">
|
|
292
|
+
```ts title="example.ts"
|
|
293
|
+
export const greeting: string = "Hello from TypeScript";
|
|
294
|
+
```
|
|
295
|
+
</CodeBlockTab>
|
|
296
|
+
<CodeBlockTab value="JavaScript">
|
|
297
|
+
```js title="example.js"
|
|
298
|
+
export const greeting = "Hello from JavaScript";
|
|
299
|
+
```
|
|
300
|
+
</CodeBlockTab>
|
|
301
|
+
</CompactCodeBlockTabs>
|
|
302
|
+
|
|
303
|
+
When migrating an existing site such as next-site, translate adjacent
|
|
304
|
+
`switcher` fences to `tab="TypeScript"` and `tab="JavaScript"`, then wrap the
|
|
305
|
+
pair with `<CodeBlockTabs compact>`. Import `@vercel/geistdocs/styles.css` (or
|
|
306
|
+
`theme.css` with the documented Geist dependencies) so Tailwind scans the
|
|
307
|
+
package's compiled components and emits the tab layout utilities.
|
|
308
|
+
|
|
197
309
|
### Framework icons
|
|
198
310
|
|
|
199
311
|
Append `#<framework>` to the title to show a framework logo instead of the
|
|
@@ -202,22 +314,22 @@ values are `#next` / `#nextjs` and `#svelte` / `#sveltekit`:
|
|
|
202
314
|
|
|
203
315
|
````md
|
|
204
316
|
```ts title="flags.ts#next"
|
|
205
|
-
import { flag } from
|
|
317
|
+
import { flag } from "flags/next";
|
|
206
318
|
```
|
|
207
319
|
|
|
208
320
|
```ts title="flags.ts#svelte"
|
|
209
|
-
import { flag } from
|
|
321
|
+
import { flag } from "flags/sveltekit";
|
|
210
322
|
```
|
|
211
323
|
````
|
|
212
324
|
|
|
213
325
|
This renders as:
|
|
214
326
|
|
|
215
327
|
```ts title="flags.ts#next"
|
|
216
|
-
import { flag } from
|
|
328
|
+
import { flag } from "flags/next";
|
|
217
329
|
```
|
|
218
330
|
|
|
219
331
|
```ts title="flags.ts#svelte"
|
|
220
|
-
import { flag } from
|
|
332
|
+
import { flag } from "flags/sveltekit";
|
|
221
333
|
```
|
|
222
334
|
|
|
223
335
|
### 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.738f050",
|
|
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": {
|