@vercel/geistdocs 2.6.1 → 2.7.0

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.
Files changed (89) hide show
  1. package/dist/cli/index.js +1 -1
  2. package/dist/internal/github-button.d.ts.map +1 -1
  3. package/dist/internal/github-button.js +2 -1
  4. package/dist/providers/public/components/badge.d.ts +13 -6
  5. package/dist/providers/public/components/badge.d.ts.map +1 -1
  6. package/dist/providers/public/components/badge.js +54 -9
  7. package/dist/providers/public/components/code-block-server.d.ts.map +1 -1
  8. package/dist/providers/public/components/code-block-server.js +13 -3
  9. package/dist/providers/public/components/filename-icon.d.ts +3 -0
  10. package/dist/providers/public/components/filename-icon.d.ts.map +1 -0
  11. package/dist/providers/public/components/filename-icon.js +13 -0
  12. package/dist/providers/public/components/input.d.ts +27 -0
  13. package/dist/providers/public/components/input.d.ts.map +1 -0
  14. package/dist/providers/public/components/input.js +27 -0
  15. package/dist/providers/public/components/theme-switcher.d.ts +5 -1
  16. package/dist/providers/public/components/theme-switcher.d.ts.map +1 -1
  17. package/dist/providers/public/components/theme-switcher.js +7 -3
  18. package/dist/providers/public/components/toggle.d.ts +26 -0
  19. package/dist/providers/public/components/toggle.d.ts.map +1 -0
  20. package/dist/providers/public/components/toggle.js +53 -0
  21. package/dist/providers/public/components/tooltip.d.ts +33 -7
  22. package/dist/providers/public/components/tooltip.d.ts.map +1 -1
  23. package/dist/providers/public/components/tooltip.js +19 -1
  24. package/dist/providers/public-assets/icons.d.ts +1 -0
  25. package/dist/providers/public-assets/icons.d.ts.map +1 -1
  26. package/dist/providers/public-assets/icons.js +1 -0
  27. package/docs/agents.md +25 -2
  28. package/docs/llms.txt +975 -14
  29. package/docs/manifest.json +211 -4
  30. package/docs/pages/components/badge.md +30 -0
  31. package/docs/pages/components/button.md +28 -0
  32. package/docs/pages/components/callout.md +28 -0
  33. package/docs/pages/components/code-block-tabs.md +49 -0
  34. package/docs/pages/components/code-block.md +26 -0
  35. package/docs/pages/components/collapsible.md +38 -0
  36. package/docs/pages/components/command-prompt.md +59 -0
  37. package/docs/pages/components/copy-prompt.md +25 -0
  38. package/docs/pages/components/details.md +37 -0
  39. package/docs/pages/components/dropdown-menu.md +43 -0
  40. package/docs/pages/components/image.md +36 -0
  41. package/docs/pages/components/index.md +49 -0
  42. package/docs/pages/components/input.md +35 -0
  43. package/docs/pages/components/link.md +28 -0
  44. package/docs/pages/components/mermaid.md +29 -0
  45. package/docs/pages/components/navigation-menu.md +50 -0
  46. package/docs/pages/components/popover.md +38 -0
  47. package/docs/pages/components/scroll-area.md +40 -0
  48. package/docs/pages/components/tabs.md +47 -0
  49. package/docs/pages/components/theme-switcher.md +32 -0
  50. package/docs/pages/components/toggle.md +37 -0
  51. package/docs/pages/components/tooltip.md +36 -0
  52. package/docs/pages/components/video.md +26 -0
  53. package/docs/pages/index.md +1 -1
  54. package/docs/pages/migration.md +4 -4
  55. package/docs/pages/syntax.md +7 -7
  56. package/docs/sitemap.md +24 -1
  57. package/package.json +29 -1
  58. package/public-foundation.css +1 -1
  59. package/template/components/geistdocs/toggle-demo.tsx +14 -0
  60. package/template/content/docs/components/badge.mdx +26 -0
  61. package/template/content/docs/components/button.mdx +24 -0
  62. package/template/content/docs/components/callout.mdx +24 -0
  63. package/template/content/docs/components/code-block-tabs.mdx +45 -0
  64. package/template/content/docs/components/code-block.mdx +22 -0
  65. package/template/content/docs/components/collapsible.mdx +34 -0
  66. package/template/content/docs/components/command-prompt.mdx +55 -0
  67. package/template/content/docs/components/copy-prompt.mdx +23 -0
  68. package/template/content/docs/components/details.mdx +33 -0
  69. package/template/content/docs/components/dropdown-menu.mdx +39 -0
  70. package/template/content/docs/components/image.mdx +32 -0
  71. package/template/content/docs/components/index.mdx +45 -0
  72. package/template/content/docs/components/input.mdx +31 -0
  73. package/template/content/docs/components/link.mdx +24 -0
  74. package/template/content/docs/components/mermaid.mdx +25 -0
  75. package/template/content/docs/components/meta.json +25 -1
  76. package/template/content/docs/components/navigation-menu.mdx +46 -0
  77. package/template/content/docs/components/popover.mdx +34 -0
  78. package/template/content/docs/components/scroll-area.mdx +36 -0
  79. package/template/content/docs/components/tabs.mdx +43 -0
  80. package/template/content/docs/components/theme-switcher.mdx +28 -0
  81. package/template/content/docs/components/toggle.mdx +33 -0
  82. package/template/content/docs/components/tooltip.mdx +32 -0
  83. package/template/content/docs/components/video.mdx +22 -0
  84. package/template/content/docs/index.mdx +1 -1
  85. package/template/content/docs/meta.json +1 -1
  86. package/template/content/docs/migration.mdx +4 -4
  87. package/template/content/docs/syntax.cn.mdx +3 -3
  88. package/template/content/docs/syntax.mdx +7 -7
  89. package/template/package.json +1 -1
package/docs/llms.txt CHANGED
@@ -1,6 +1,6 @@
1
1
  # Geistdocs Package Documentation
2
2
 
3
- These docs are bundled with `@vercel/geistdocs` 2.6.1.
3
+ These docs are bundled with `@vercel/geistdocs` 2.7.0.
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
@@ -12,7 +12,7 @@ They describe how to build package-backed Geistdocs sites and how to use the pac
12
12
  - [Migrate to Geistdocs](pages/migration.md): Move an existing documentation site to @vercel/geistdocs while keeping local content, routing, middleware behavior, and AI-readable surfaces intact.
13
13
  - [Choose a Geistdocs package](pages/packages.md): Use the public package by default and the private package only where restricted Vercel npm dependencies are already available.
14
14
  - [Configuration](pages/configuration.md): Configure site metadata, navigation, AI features, page actions, translations, and local adapters.
15
- - [Syntax](pages/syntax.md): Supported MDX components and syntax including tabs, text formatting, code blocks, line highlighting, and Mermaid diagrams.
15
+ - [MDX Components](pages/syntax.md): MDX component and authoring reference covering tabs, text formatting, code blocks, line highlighting, and Mermaid diagrams.
16
16
  - [Geistdocs Provider](pages/provider.md): The root provider component that wraps your application to handle toast notifications, search, and analytics.
17
17
  - [Versioned docs](pages/versioned-docs.md): Use createVersionedSources to configure stable, pre-release, or host-based documentation versions.
18
18
  - [Proxy and markdown routes](pages/proxy.md): Configure createProxy with generated route discovery, request hooks, markdown mappings, and a static Next.js matcher.
@@ -20,16 +20,39 @@ They describe how to build package-backed Geistdocs sites and how to use the pac
20
20
  - [.md Extension](pages/md.md): Access any documentation page as raw Markdown by appending .md or .mdx to the URL for AI tool consumption.
21
21
  - [Agent readiness](pages/agent-readiness.md): Generate /agents.md and /.well-known/mcp.json from Geistdocs config so agents can find docs, Markdown surfaces, API specs, and MCP endpoints.
22
22
  - [Ask AI](pages/ask-ai.md): An AI-powered chat assistant with context-aware search, persistent history, and suggested prompts for your documentation.
23
+ - [Badge](pages/components/badge.md): Import Badge from the package component subpath for labels outside authored MDX.
24
+ - [Button](pages/components/button.md): Use the provider-backed Button in application UI or directly in MDX.
25
+ - [Callout](pages/components/callout.md): Use Callout directly or compose its container, title, and description primitives.
26
+ - [Code Block](pages/components/code-block.md): Use CodeBlock when code is highlighted or assembled outside authored Markdown fences.
27
+ - [Code Block Tabs](pages/components/code-block-tabs.md): Compose code-block tab lists, triggers, and panels outside authored MDX.
28
+ - [Collapsible](pages/components/collapsible.md): Compose Collapsible, CollapsibleTrigger, and CollapsibleContent in custom React UI.
29
+ - [Command Prompt](pages/components/command-prompt.md): Compose the CommandPrompt primitives for application-owned install and setup commands.
30
+ - [Components](pages/components/index.md): Browse every component subpath exported by Geistdocs. These components can be imported into application code without relying on the default MDX component map.
23
31
  - [Configure sidebar navigation](pages/guides/nested-navigation.md): Configure sidebar order, section labels, folder landing pages, and deeply nested page trees with meta.json files.
32
+ - [Copy Prompt](pages/components/copy-prompt.md): Use CopyPrompt for reusable instructions that readers can send to an AI assistant.
33
+ - [Details](pages/components/details.md): Compose Details and Summary for accessible browser-native disclosures.
34
+ - [Dropdown Menu](pages/components/dropdown-menu.md): Compose DropdownMenu primitives for application-owned menus outside MDX.
24
35
  - [Edit on GitHub](pages/edit-on-github.md): A direct link on every documentation page that lets readers propose changes through GitHub pull requests.
25
36
  - [Feedback](pages/feedback.md): An interactive feedback widget that collects user sentiment and creates structured GitHub Issues automatically.
37
+ - [Image](pages/components/image.md): Use the Geistdocs Image wrapper for documentation-aware Next.js images.
26
38
  - [Improve Ask AI answers with Mixedbread](pages/mixedbread-retrieval.md): Provision a Mixedbread Store for one Geistdocs consumer site, enable semantic retrieval, and sync documentation during production builds.
39
+ - [Input](pages/components/input.md): Use Input for text entry in custom documentation and application interfaces.
27
40
  - [Internationalization](pages/internationalization.md): Serve documentation in multiple languages with automatic translation via the Geistdocs CLI and Fumadocs routing.
28
41
  - [llms.txt](pages/llms-txt.md): A single endpoint that returns all documentation as plain Markdown text following the llms.txt standard.
42
+ - [Mermaid](pages/components/mermaid.md): Use Mermaid directly when diagram source is assembled outside an MDX Mermaid fence.
43
+ - [Native Link](pages/components/link.md): Use NativeDocsLink where Next.js client navigation is not appropriate.
44
+ - [Navigation Menu](pages/components/navigation-menu.md): Compose NavigationMenu primitives for custom product and documentation navigation.
29
45
  - [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.
46
+ - [Popover](pages/components/popover.md): Compose Popover, PopoverTrigger, and PopoverContent outside MDX.
30
47
  - [RSS](pages/rss.md): An automatically generated RSS 2.0 feed that keeps users informed when documentation is published or updated.
48
+ - [Scroll Area](pages/components/scroll-area.md): Compose ScrollArea and ScrollBar for constrained custom interfaces.
31
49
  - [Steps](pages/components/steps.md): Write consecutive headings that start with a number, such as "### 1. Install", to render a numbered step list. The Steps and Step components cover cases where a heading must be wrapped in another component.
32
50
  - [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.
51
+ - [Tabs](pages/components/tabs.md): Use Tabs for navigation-only controls or TabsWithChildren and TabContent for mounted content panels.
52
+ - [Theme Switcher](pages/components/theme-switcher.md): Use ThemeSwitcher in custom navigation, settings, and footer UI.
53
+ - [Toggle](pages/components/toggle.md): Toggle is the provider-backed replacement for the former Switch export.
54
+ - [Tooltip](pages/components/tooltip.md): Wrap controls with provider-backed Tooltip content outside MDX.
55
+ - [Video](pages/components/video.md): Use Video for embedded video sources inside React UI or authored MDX.
33
56
  - [WebMCP](pages/webmcp.md): Expose documentation search and page reading to browser agents.
34
57
 
35
58
  ---
@@ -133,7 +156,7 @@ Advanced projects can use package APIs for versioned docs, multiple content sour
133
156
  - Read [Configuration](/docs/configuration) to customize the generated site.
134
157
  - Read [Versioned docs](/docs/versioned-docs) to configure multiple docs versions.
135
158
  - Read [Proxy and markdown routes](/docs/proxy) to add custom request logic.
136
- - Read [Syntax](/docs/syntax) to write content with MDX components.
159
+ - Read [MDX Components](/docs/syntax) to author content with the default component map.
137
160
 
138
161
 
139
162
  ---
@@ -572,12 +595,12 @@ Replace imports according to this table:
572
595
 
573
596
  | Previous Geistdocs import | Replacement |
574
597
  | --- | --- |
575
- | `components/badge`, `components/button`, or `components/theme-switcher` | Keep the import package-backed. Geistdocs resolves these template primitives through the selected public or private provider. |
576
- | `components/dialog`, `components/drawer`, `components/input`, `components/kbd`, `components/separator`, `components/sheet`, `components/spinner`, `components/textarea`, or `components/tooltip` | Import the matching component directly from `@vercel/geistcn/components/<name>` in approved private projects, or keep an application-owned public equivalent. |
577
- | `components/switch` | Import toggle controls from `@vercel/geistcn/components/toggle`. |
598
+ | `components/badge`, `components/button`, `components/input`, `components/theme-switcher`, or `components/tooltip` | Keep the import package-backed. Geistdocs resolves these template primitives through the selected public or private provider. |
599
+ | `components/dialog`, `components/drawer`, `components/kbd`, `components/separator`, `components/sheet`, `components/spinner`, or `components/textarea` | Import the matching component directly from `@vercel/geistcn/components/<name>` in approved private projects, or keep an application-owned public equivalent. |
600
+ | `components/switch` | Replace `Switch` with package-backed `Toggle` from `components/toggle`, and replace `onCheckedChange` with `onChange`. |
578
601
  | `components/sonner` | Use `Toasts` and `useToasts` from `@vercel/geistcn/components/toasts`. |
579
602
  | `components/theme-aware-image` | Use `Image` from `@vercel/geistcn/components/image` with `srcLight` and `srcDark`. |
580
- | `assets/icons`, `assets/icons/*`, `assets/logos`, or `assets/logos/*` | Import from `@vercel/geistcn-assets/icons`, `@vercel/geistcn-assets/icons/*`, `@vercel/geistcn-assets/logos`, or `@vercel/geistcn-assets/logos/*`. |
603
+ | `assets/icons`, `assets/icons/*`, `assets/logos`, or `assets/logos/*` | Keep the import package-backed. Both Geistdocs package variants expose the index and deep asset subpaths. |
581
604
  | `components/button-group`, `components/card`, or `components/input-group` | Use an appropriate Geistcn component or keep an application-owned composition. There is no direct Geistcn replacement with the same API. |
582
605
 
583
606
  Keep documentation-specific composites such as `Callout`, `CodeBlock`, `CodeBlockTabs`, `CommandPrompt`, `CopyPrompt`, and `Mermaid` imported from `@vercel/geistdocs/components/*`.
@@ -1553,10 +1576,10 @@ If a release adds an optional prop or config field, opt into it by editing the r
1553
1576
  ---
1554
1577
 
1555
1578
  ---
1556
- title: Syntax
1557
- description: Learn about the supported markdown syntax and formatting options
1579
+ title: MDX Components
1580
+ description: Author MDX content with supported components, Markdown syntax, and formatting options
1558
1581
  type: reference
1559
- summary: Supported MDX components and syntax including tabs, text formatting, code blocks, line highlighting, and Mermaid diagrams.
1582
+ summary: MDX component and authoring reference covering tabs, text formatting, code blocks, line highlighting, and Mermaid diagrams.
1560
1583
  url: /docs/syntax
1561
1584
  source: apps/template/content/docs/syntax.mdx
1562
1585
  prerequisites:
@@ -1565,13 +1588,13 @@ related:
1565
1588
  - /docs/configuration
1566
1589
  ---
1567
1590
 
1568
- # Syntax
1591
+ # MDX Components
1569
1592
 
1570
1593
  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.
1571
1594
 
1572
- Help me write a Geistdocs MDX page. Use this page as a syntax reference and
1573
- create an example page with frontmatter, headings, links, a code block, a
1574
- `Callout`, and a `CopyPrompt` component.
1595
+ Help me write a Geistdocs MDX page. Use this page as an MDX component
1596
+ reference and create an example page with frontmatter, headings, links, a
1597
+ code block, a `Callout`, and a `CopyPrompt` component.
1575
1598
 
1576
1599
  ## Frontmatter
1577
1600
 
@@ -3939,6 +3962,345 @@ In default AI Gateway mode, Geistdocs uses `openai/gpt-5.6-sol` via the Vercel A
3939
3962
  You can customize the initial suggested prompts shown to users. These are configured in the Geistdocs configuration file, which you can read more about in the [Configuration](/docs/configuration) section.
3940
3963
 
3941
3964
 
3965
+ ---
3966
+
3967
+ ---
3968
+ title: Badge
3969
+ description: Render compact status and category labels
3970
+ type: reference
3971
+ summary: Import Badge from the package component subpath for labels outside authored MDX.
3972
+ url: /docs/components/badge
3973
+ source: apps/template/content/docs/components/badge.mdx
3974
+ related:
3975
+ - /docs/components
3976
+ ---
3977
+
3978
+ # Badge
3979
+
3980
+ import { Badge } from "@vercel/geistdocs/components/badge";
3981
+
3982
+ <div className="not-prose my-6 flex min-h-32 items-center justify-center rounded-lg border border-gray-400 bg-background-100 p-6">
3983
+ <Badge variant="blue">New</Badge>
3984
+ </div>
3985
+
3986
+ Import `Badge` from the selected Geistdocs package:
3987
+
3988
+ ```tsx
3989
+ import { Badge } from "@vercel/geistdocs/components/badge";
3990
+
3991
+ export function Status() {
3992
+ return <Badge variant="blue">New</Badge>;
3993
+ }
3994
+ ```
3995
+
3996
+ The public variant supports `gray`, `blue`, `red`, `amber`, and `green` tones. The private package resolves the component through Geistcn.
3997
+
3998
+
3999
+ ---
4000
+
4001
+ ---
4002
+ title: Button
4003
+ description: Render buttons and link-style actions
4004
+ type: reference
4005
+ summary: Use the provider-backed Button in application UI or directly in MDX.
4006
+ url: /docs/components/button
4007
+ source: apps/template/content/docs/components/button.mdx
4008
+ related:
4009
+ - /docs/components
4010
+ ---
4011
+
4012
+ # Button
4013
+
4014
+ import { Button } from "@vercel/geistdocs/components/button";
4015
+
4016
+ <div className="not-prose my-6 flex min-h-32 items-center justify-center rounded-lg border border-gray-400 bg-background-100 p-6">
4017
+ <Button variant="secondary">Continue</Button>
4018
+ </div>
4019
+
4020
+ ```tsx
4021
+ import { Button } from "@vercel/geistdocs/components/button";
4022
+
4023
+ export function Actions() {
4024
+ return <Button variant="secondary">Continue</Button>;
4025
+ }
4026
+ ```
4027
+
4028
+ `Button` supports native buttons, anchors, and internal localized links. It is also included in the default MDX component map.
4029
+
4030
+
4031
+ ---
4032
+
4033
+ ---
4034
+ title: Callout
4035
+ description: Render notices with optional titles and descriptions
4036
+ type: reference
4037
+ summary: Use Callout directly or compose its container, title, and description primitives.
4038
+ url: /docs/components/callout
4039
+ source: apps/template/content/docs/components/callout.mdx
4040
+ related:
4041
+ - /docs/components
4042
+ ---
4043
+
4044
+ # Callout
4045
+
4046
+ import { Callout } from "@vercel/geistdocs/components/callout";
4047
+
4048
+ <div className="not-prose my-6 rounded-lg border border-gray-400 bg-background-100 p-6">
4049
+ > Restart the dev server after changing configuration.
4050
+ </div>
4051
+
4052
+ ```tsx
4053
+ import { Callout } from "@vercel/geistdocs/components/callout";
4054
+
4055
+ export function Notice() {
4056
+ return <Callout title="Note">Restart the dev server after changing configuration.</Callout>;
4057
+ }
4058
+ ```
4059
+
4060
+ The subpath also exports `CalloutContainer`, `CalloutTitle`, and `CalloutDescription`. These components are included in the default MDX component map.
4061
+
4062
+
4063
+ ---
4064
+
4065
+ ---
4066
+ title: Code Block
4067
+ description: Render highlighted code with filename and copy controls
4068
+ type: reference
4069
+ summary: Use CodeBlock when code is highlighted or assembled outside authored Markdown fences.
4070
+ url: /docs/components/code-block
4071
+ source: apps/template/content/docs/components/code-block.mdx
4072
+ related:
4073
+ - /docs/components
4074
+ - /docs/components/code-block-tabs
4075
+ - /docs/syntax
4076
+ ---
4077
+
4078
+ # Code Block
4079
+
4080
+ import { CodeBlock } from "@vercel/geistdocs/components/code-block";
4081
+
4082
+ <div className="not-prose my-6">
4083
+ <CodeBlock title="example.ts">{'export const enabled = true;'}</CodeBlock>
4084
+ </div>
4085
+
4086
+ ```tsx
4087
+ import { CodeBlock } from "@vercel/geistdocs/components/code-block";
4088
+ ```
4089
+
4090
+ Pass a `title` to show header chrome with a filename-aware icon and copy control. Markdown code fences use `CodeBlock` automatically through the default MDX map.
4091
+
4092
+
4093
+ ---
4094
+
4095
+ ---
4096
+ title: Code Block Tabs
4097
+ description: Group multiple code examples in one tabbed surface
4098
+ type: reference
4099
+ summary: Compose code-block tab lists, triggers, and panels outside authored MDX.
4100
+ url: /docs/components/code-block-tabs
4101
+ source: apps/template/content/docs/components/code-block-tabs.mdx
4102
+ related:
4103
+ - /docs/components
4104
+ - /docs/components/code-block
4105
+ - /docs/syntax
4106
+ ---
4107
+
4108
+ # Code Block Tabs
4109
+
4110
+ import { CodeBlock } from "@vercel/geistdocs/components/code-block";
4111
+ import {
4112
+ CodeBlockTab,
4113
+ CodeBlockTabs,
4114
+ CodeBlockTabsList,
4115
+ CodeBlockTabsTrigger,
4116
+ } from "@vercel/geistdocs/components/code-block-tabs";
4117
+
4118
+ <div className="not-prose my-6">
4119
+ <CodeBlockTabs defaultValue="pnpm">
4120
+ <CodeBlockTabsList>
4121
+ <CodeBlockTabsTrigger value="pnpm">pnpm</CodeBlockTabsTrigger>
4122
+ <CodeBlockTabsTrigger value="npm">npm</CodeBlockTabsTrigger>
4123
+ </CodeBlockTabsList>
4124
+ <CodeBlockTab value="pnpm">
4125
+ <CodeBlock title="Terminal">pnpm add @vercel/geistdocs</CodeBlock>
4126
+ </CodeBlockTab>
4127
+ <CodeBlockTab value="npm">
4128
+ <CodeBlock title="Terminal">npm install @vercel/geistdocs</CodeBlock>
4129
+ </CodeBlockTab>
4130
+ </CodeBlockTabs>
4131
+ </div>
4132
+
4133
+ ```tsx
4134
+ import {
4135
+ CodeBlockTab,
4136
+ CodeBlockTabs,
4137
+ CodeBlockTabsList,
4138
+ CodeBlockTabsTrigger,
4139
+ CompactCodeBlockTabs,
4140
+ } from "@vercel/geistdocs/components/code-block-tabs";
4141
+ ```
4142
+
4143
+ The same components are available without imports in authored MDX.
4144
+
4145
+
4146
+ ---
4147
+
4148
+ ---
4149
+ title: Collapsible
4150
+ description: Show and hide expandable content regions
4151
+ type: reference
4152
+ summary: Compose Collapsible, CollapsibleTrigger, and CollapsibleContent in custom React UI.
4153
+ url: /docs/components/collapsible
4154
+ source: apps/template/content/docs/components/collapsible.mdx
4155
+ related:
4156
+ - /docs/components
4157
+ - /docs/components/details
4158
+ ---
4159
+
4160
+ # Collapsible
4161
+
4162
+ import {
4163
+ Collapsible,
4164
+ CollapsibleContent,
4165
+ CollapsibleTrigger,
4166
+ } from "@vercel/geistdocs/components/collapsible";
4167
+
4168
+ <div className="not-prose my-6 flex min-h-32 items-center justify-center rounded-lg border border-gray-400 bg-background-100 p-6">
4169
+ <Collapsible className="w-full max-w-sm" defaultOpen>
4170
+ <CollapsibleTrigger className="font-medium">Advanced options</CollapsibleTrigger>
4171
+ <CollapsibleContent className="pt-3 text-gray-900">
4172
+ Configure optional behavior here.
4173
+ </CollapsibleContent>
4174
+ </Collapsible>
4175
+ </div>
4176
+
4177
+ ```tsx
4178
+ import {
4179
+ Collapsible,
4180
+ CollapsibleContent,
4181
+ CollapsibleTrigger,
4182
+ } from "@vercel/geistdocs/components/collapsible";
4183
+ ```
4184
+
4185
+ Use the native [Details](/docs/components/details) component when browser-native disclosure behavior is sufficient.
4186
+
4187
+
4188
+ ---
4189
+
4190
+ ---
4191
+ title: Command Prompt
4192
+ description: Render copyable commands and selectable command alternatives
4193
+ type: reference
4194
+ summary: Compose the CommandPrompt primitives for application-owned install and setup commands.
4195
+ url: /docs/components/command-prompt
4196
+ source: apps/template/content/docs/components/command-prompt.mdx
4197
+ related:
4198
+ - /docs/components
4199
+ - /docs/components/copy-prompt
4200
+ ---
4201
+
4202
+ # Command Prompt
4203
+
4204
+ import {
4205
+ CommandPromptContent,
4206
+ CommandPromptCopy,
4207
+ CommandPromptList,
4208
+ CommandPromptPrefix,
4209
+ CommandPromptRoot,
4210
+ CommandPromptSurface,
4211
+ CommandPromptTrigger,
4212
+ CommandPromptTriggerDivider,
4213
+ CommandPromptViewport,
4214
+ } from "@vercel/geistdocs/components/command-prompt";
4215
+
4216
+ <div className="not-prose my-6 flex min-h-32 items-center justify-center rounded-lg border border-gray-400 bg-background-100 p-6">
4217
+ <CommandPromptRoot defaultValue="pnpm">
4218
+ <CommandPromptList>
4219
+ <CommandPromptTrigger value="pnpm">pnpm</CommandPromptTrigger>
4220
+ <CommandPromptTriggerDivider />
4221
+ <CommandPromptTrigger value="npm">npm</CommandPromptTrigger>
4222
+ </CommandPromptList>
4223
+ <CommandPromptSurface>
4224
+ <CommandPromptPrefix>$</CommandPromptPrefix>
4225
+ <CommandPromptViewport>
4226
+ <CommandPromptContent value="pnpm">pnpm add @vercel/geistdocs</CommandPromptContent>
4227
+ <CommandPromptContent value="npm">npm install @vercel/geistdocs</CommandPromptContent>
4228
+ </CommandPromptViewport>
4229
+ <CommandPromptCopy aria-label="Copy command" />
4230
+ </CommandPromptSurface>
4231
+ </CommandPromptRoot>
4232
+ </div>
4233
+
4234
+ ```tsx
4235
+ import {
4236
+ CommandPromptContent,
4237
+ CommandPromptCopy,
4238
+ CommandPromptList,
4239
+ CommandPromptPrefix,
4240
+ CommandPromptRoot,
4241
+ CommandPromptSurface,
4242
+ CommandPromptTrigger,
4243
+ CommandPromptTriggerDivider,
4244
+ CommandPromptViewport,
4245
+ } from "@vercel/geistdocs/components/command-prompt";
4246
+ ```
4247
+
4248
+ `CommandPromptRoot` owns the active command and copy state. Compose the remaining primitives within it to build a single command or a selectable package-manager list.
4249
+
4250
+
4251
+ ---
4252
+
4253
+ ---
4254
+ title: Components
4255
+ description: Importable React components exposed by Geistdocs for application UI and documentation experiences
4256
+ type: overview
4257
+ summary: Browse every component subpath exported by Geistdocs. These components can be imported into application code without relying on the default MDX component map.
4258
+ url: /docs/components/index
4259
+ source: apps/template/content/docs/components/index.mdx
4260
+ related:
4261
+ - /docs/syntax
4262
+ - /docs/packages
4263
+ ---
4264
+
4265
+ # Components
4266
+
4267
+ Geistdocs exports reusable React components for application UI, custom documentation layouts, and authored content. Import from the package variant selected by your project:
4268
+
4269
+ ```tsx
4270
+ import { Button } from "@vercel/geistdocs/components/button";
4271
+ ```
4272
+
4273
+ Internal projects using `@vercel/geistdocs-private` use the same component subpaths. The private package resolves primitives through Geistcn; the public package provides public equivalents.
4274
+
4275
+ | Component | Import subpath | Purpose |
4276
+ | --- | --- | --- |
4277
+ | [Badge](/docs/components/badge) | `components/badge` | Compact status and category labels |
4278
+ | [Button](/docs/components/button) | `components/button` | Buttons and link-style actions |
4279
+ | [Input](/docs/components/input) | `components/input` | Text input fields with provider-backed styling |
4280
+ | [Toggle](/docs/components/toggle) | `components/toggle` | Controlled boolean controls |
4281
+ | [Tooltip](/docs/components/tooltip) | `components/tooltip` | Contextual hover and focus labels |
4282
+ | [Theme Switcher](/docs/components/theme-switcher) | `components/theme-switcher` | System, light, and dark theme selection |
4283
+ | [Tabs](/docs/components/tabs) | `components/tabs`, `components/tabs-with-children` | Tab navigation and mounted content panels |
4284
+ | [Collapsible](/docs/components/collapsible) | `components/collapsible` | Expandable content regions |
4285
+ | [Details](/docs/components/details) | `components/details` | Styled native disclosure elements |
4286
+ | [Callout](/docs/components/callout) | `components/callout` | Notices with optional titles and descriptions |
4287
+ | [Code Block](/docs/components/code-block) | `components/code-block` | Highlighted code with filename and copy controls |
4288
+ | [Code Block Tabs](/docs/components/code-block-tabs) | `components/code-block-tabs` | Multiple code examples in one tabbed surface |
4289
+ | [Command Prompt](/docs/components/command-prompt) | `components/command-prompt` | Command surfaces with copy support and alternatives |
4290
+ | [Copy Prompt](/docs/components/copy-prompt) | `components/copy-prompt` | Copyable prompts for agents and language models |
4291
+ | [Dropdown Menu](/docs/components/dropdown-menu) | `components/dropdown-menu` | Accessible action menus |
4292
+ | [Navigation Menu](/docs/components/navigation-menu) | `components/navigation-menu` | Accessible navigation flyouts |
4293
+ | [Popover](/docs/components/popover) | `components/popover` | Anchored floating content |
4294
+ | [Scroll Area](/docs/components/scroll-area) | `components/scroll-area` | Styled overflow regions and scrollbars |
4295
+ | [Image](/docs/components/image) | `components/image` | Next.js images with optional light and dark sources |
4296
+ | [Native Link](/docs/components/link) | `components/link` | Styled anchors using browser-native navigation |
4297
+ | [Mermaid](/docs/components/mermaid) | `components/mermaid` | Mermaid diagram rendering |
4298
+ | [Video](/docs/components/video) | `components/video` | Responsive video playback |
4299
+ | [Steps](/docs/components/steps) | `components/steps` | Numbered procedural content |
4300
+
4301
+ Components such as `Button`, `Callout`, `CodeBlock`, and `Steps` are also included in the default MDX component map. Importing them directly is useful in React components, layouts, and custom page renderers.
4302
+
4303
+
3942
4304
  ---
3943
4305
 
3944
4306
  ---
@@ -4178,6 +4540,123 @@ Check these rules when a page or folder does not appear where expected:
4178
4540
  - Keep separator labels between three hyphens on each side, such as `---Internals---`.
4179
4541
 
4180
4542
 
4543
+ ---
4544
+
4545
+ ---
4546
+ title: Copy Prompt
4547
+ description: Render copyable prompts for agents and language models
4548
+ type: reference
4549
+ summary: Use CopyPrompt for reusable instructions that readers can send to an AI assistant.
4550
+ url: /docs/components/copy-prompt
4551
+ source: apps/template/content/docs/components/copy-prompt.mdx
4552
+ related:
4553
+ - /docs/components
4554
+ - /docs/components/command-prompt
4555
+ ---
4556
+
4557
+ # Copy Prompt
4558
+
4559
+ import { CopyPrompt } from "@vercel/geistdocs/components/copy-prompt";
4560
+
4561
+ ```tsx
4562
+ import { CopyPrompt } from "@vercel/geistdocs/components/copy-prompt";
4563
+
4564
+ export function ReviewPrompt() {
4565
+ return <CopyPrompt text="Review this project and propose the safest migration plan." />;
4566
+ }
4567
+ ```
4568
+
4569
+ `CopyPrompt` is also included in the default MDX component map.
4570
+
4571
+
4572
+ ---
4573
+
4574
+ ---
4575
+ title: Details
4576
+ description: Render styled native disclosure elements
4577
+ type: reference
4578
+ summary: Compose Details and Summary for accessible browser-native disclosures.
4579
+ url: /docs/components/details
4580
+ source: apps/template/content/docs/components/details.mdx
4581
+ related:
4582
+ - /docs/components
4583
+ - /docs/components/collapsible
4584
+ ---
4585
+
4586
+ # Details
4587
+
4588
+ import { Details, Summary } from "@vercel/geistdocs/components/details";
4589
+
4590
+ <div className="not-prose my-6 min-h-32 rounded-lg border border-gray-400 bg-background-100 p-6">
4591
+ <Details open>
4592
+ <Summary>Advanced options</Summary>
4593
+ Configure optional behavior here.
4594
+ </Details>
4595
+ </div>
4596
+
4597
+ ```tsx
4598
+ import { Details, Summary } from "@vercel/geistdocs/components/details";
4599
+
4600
+ export function Disclosure() {
4601
+ return (
4602
+ <Details>
4603
+ <Summary>Advanced options</Summary>
4604
+ Configure optional behavior here.
4605
+ </Details>
4606
+ );
4607
+ }
4608
+ ```
4609
+
4610
+ `Details` and `Summary` are also included in the default MDX component map.
4611
+
4612
+
4613
+ ---
4614
+
4615
+ ---
4616
+ title: Dropdown Menu
4617
+ description: Render accessible action and selection menus
4618
+ type: reference
4619
+ summary: Compose DropdownMenu primitives for application-owned menus outside MDX.
4620
+ url: /docs/components/dropdown-menu
4621
+ source: apps/template/content/docs/components/dropdown-menu.mdx
4622
+ related:
4623
+ - /docs/components
4624
+ - /docs/components/popover
4625
+ ---
4626
+
4627
+ # Dropdown Menu
4628
+
4629
+ import {
4630
+ DropdownMenu,
4631
+ DropdownMenuContent,
4632
+ DropdownMenuItem,
4633
+ DropdownMenuTrigger,
4634
+ } from "@vercel/geistdocs/components/dropdown-menu";
4635
+
4636
+ <div className="not-prose my-6 flex min-h-32 items-center justify-center rounded-lg border border-gray-400 bg-background-100 p-6">
4637
+ <DropdownMenu>
4638
+ <DropdownMenuTrigger className="h-8 rounded-md border border-gray-400 bg-background-100 px-3">
4639
+ Open menu
4640
+ </DropdownMenuTrigger>
4641
+ <DropdownMenuContent>
4642
+ <DropdownMenuItem>Edit</DropdownMenuItem>
4643
+ <DropdownMenuItem>Duplicate</DropdownMenuItem>
4644
+ </DropdownMenuContent>
4645
+ </DropdownMenu>
4646
+ </div>
4647
+
4648
+ ```tsx
4649
+ import {
4650
+ DropdownMenu,
4651
+ DropdownMenuContent,
4652
+ DropdownMenuItem,
4653
+ DropdownMenuTrigger,
4654
+ } from "@vercel/geistdocs/components/dropdown-menu";
4655
+ ```
4656
+
4657
+ The subpath also exports label, separator, checkbox, radio, and nested submenu primitives.
4658
+
4659
+
4181
4660
  ---
4182
4661
 
4183
4662
  ---
@@ -4330,6 +4809,46 @@ Pass any additional fields in the request body, and they are captured as metadat
4330
4809
  - Custom tracking data
4331
4810
 
4332
4811
 
4812
+ ---
4813
+
4814
+ ---
4815
+ title: Image
4816
+ description: Render optimized images with optional light and dark sources
4817
+ type: reference
4818
+ summary: Use the Geistdocs Image wrapper for documentation-aware Next.js images.
4819
+ url: /docs/components/image
4820
+ source: apps/template/content/docs/components/image.mdx
4821
+ related:
4822
+ - /docs/components
4823
+ - /docs/syntax
4824
+ ---
4825
+
4826
+ # Image
4827
+
4828
+ import { Image } from "@vercel/geistdocs/components/image";
4829
+
4830
+ <div className="not-prose my-6 flex min-h-40 items-center justify-center rounded-lg border border-gray-400 bg-background-100 p-6">
4831
+ <Image
4832
+ alt="Geistdocs preview favicon"
4833
+ className="size-16"
4834
+ figureClassName="my-0 w-auto"
4835
+ height={64}
4836
+ src="/favicon.preview.ico"
4837
+ width={64}
4838
+ />
4839
+ </div>
4840
+
4841
+ ```tsx
4842
+ import { Image } from "@vercel/geistdocs/components/image";
4843
+
4844
+ export function Screenshot() {
4845
+ return <Image alt="Project dashboard" src="/dashboard.png" />;
4846
+ }
4847
+ ```
4848
+
4849
+ Pass `srcLight` and `srcDark` for theme-aware artwork. `Image` is also included in the default MDX component map.
4850
+
4851
+
4333
4852
  ---
4334
4853
 
4335
4854
  ---
@@ -4478,6 +4997,45 @@ vercel integration open mixedbread
4478
4997
  Ask a question that uses different words from the page title. Ask AI should cite the relevant page and answer from the matching section. If Mixedbread returns an error or exceeds the request timeout, Geistdocs logs a warning and retries the question with local Orama retrieval.
4479
4998
 
4480
4999
 
5000
+ ---
5001
+
5002
+ ---
5003
+ title: Input
5004
+ description: Render accessible provider-backed text inputs
5005
+ type: reference
5006
+ summary: Use Input for text entry in custom documentation and application interfaces.
5007
+ url: /docs/components/input
5008
+ source: apps/template/content/docs/components/input.mdx
5009
+ related:
5010
+ - /docs/components
5011
+ - /docs/components/toggle
5012
+ ---
5013
+
5014
+ # Input
5015
+
5016
+ import { Input } from "@vercel/geistdocs/components/input";
5017
+
5018
+ <div className="not-prose my-6 flex min-h-32 items-center justify-center rounded-lg border border-gray-400 bg-background-100 p-6">
5019
+ <Input
5020
+ aria-label="Project domain"
5021
+ defaultValue="geistdocs"
5022
+ prefix="https://"
5023
+ suffix=".dev"
5024
+ width={320}
5025
+ />
5026
+ </div>
5027
+
5028
+ ```tsx
5029
+ import { Input } from "@vercel/geistdocs/components/input";
5030
+
5031
+ export function SearchField() {
5032
+ return <Input aria-label="Search documentation" placeholder="Search" />;
5033
+ }
5034
+ ```
5035
+
5036
+ Use `typeName` for the native input type. Labels, prefix and suffix adornments, error content, sizes, and rounded fields are supported by the public provider; the private package resolves the component through Geistcn.
5037
+
5038
+
4481
5039
  ---
4482
5040
 
4483
5041
  ---
@@ -4701,6 +5259,125 @@ The llms.txt standard is a simple convention that makes documentation more acces
4701
5259
  Learn more at [llmstxt.org](https://llmstxt.org/)
4702
5260
 
4703
5261
 
5262
+ ---
5263
+
5264
+ ---
5265
+ title: Mermaid
5266
+ description: Render Mermaid diagrams from chart source
5267
+ type: reference
5268
+ summary: Use Mermaid directly when diagram source is assembled outside an MDX Mermaid fence.
5269
+ url: /docs/components/mermaid
5270
+ source: apps/template/content/docs/components/mermaid.mdx
5271
+ related:
5272
+ - /docs/components
5273
+ - /docs/syntax
5274
+ ---
5275
+
5276
+ # Mermaid
5277
+
5278
+ import { Mermaid } from "@vercel/geistdocs/components/mermaid";
5279
+
5280
+ <div className="not-prose my-6 rounded-lg border border-gray-400 bg-background-100 p-6">
5281
+ <Mermaid chart={'graph LR; A["Start"] --> B["Finish"]'} />
5282
+ </div>
5283
+
5284
+ ```tsx
5285
+ import { Mermaid } from "@vercel/geistdocs/components/mermaid";
5286
+
5287
+ export function Flow() {
5288
+ return <Mermaid chart={'graph LR; A["Start"] --> B["Finish"]'} />;
5289
+ }
5290
+ ```
5291
+
5292
+ Mermaid code fences render this component automatically in authored MDX.
5293
+
5294
+
5295
+ ---
5296
+
5297
+ ---
5298
+ title: Native Link
5299
+ description: Render styled anchors with browser-native navigation
5300
+ type: reference
5301
+ summary: Use NativeDocsLink where Next.js client navigation is not appropriate.
5302
+ url: /docs/components/link
5303
+ source: apps/template/content/docs/components/link.mdx
5304
+ related:
5305
+ - /docs/components
5306
+ ---
5307
+
5308
+ # Native Link
5309
+
5310
+ import { NativeDocsLink } from "@vercel/geistdocs/components/link";
5311
+
5312
+ <div className="not-prose my-6 flex min-h-32 items-center justify-center rounded-lg border border-gray-400 bg-background-100 p-6">
5313
+ <NativeDocsLink href="/docs/getting-started">Read the getting started guide</NativeDocsLink>
5314
+ </div>
5315
+
5316
+ ```tsx
5317
+ import { NativeDocsLink } from "@vercel/geistdocs/components/link";
5318
+
5319
+ export function DownloadLink() {
5320
+ return <NativeDocsLink href="/download">Download</NativeDocsLink>;
5321
+ }
5322
+ ```
5323
+
5324
+ Use this component for links that must retain native document navigation. The default MDX link resolver already handles internal and external authored links.
5325
+
5326
+
5327
+ ---
5328
+
5329
+ ---
5330
+ title: Navigation Menu
5331
+ description: Render accessible navigation links and flyout content
5332
+ type: reference
5333
+ summary: Compose NavigationMenu primitives for custom product and documentation navigation.
5334
+ url: /docs/components/navigation-menu
5335
+ source: apps/template/content/docs/components/navigation-menu.mdx
5336
+ related:
5337
+ - /docs/components
5338
+ - /docs/components/dropdown-menu
5339
+ ---
5340
+
5341
+ # Navigation Menu
5342
+
5343
+ import {
5344
+ NavigationMenu,
5345
+ NavigationMenuContent,
5346
+ NavigationMenuItem,
5347
+ NavigationMenuLink,
5348
+ NavigationMenuList,
5349
+ NavigationMenuTrigger,
5350
+ } from "@vercel/geistdocs/components/navigation-menu";
5351
+
5352
+ <div className="not-prose my-6 flex min-h-40 items-start justify-center rounded-lg border border-gray-400 bg-background-100 p-6">
5353
+ <NavigationMenu>
5354
+ <NavigationMenuList>
5355
+ <NavigationMenuItem>
5356
+ <NavigationMenuTrigger>Guides</NavigationMenuTrigger>
5357
+ <NavigationMenuContent>
5358
+ <NavigationMenuLink className="block w-56 p-3" href="/docs/getting-started">
5359
+ Getting started
5360
+ </NavigationMenuLink>
5361
+ </NavigationMenuContent>
5362
+ </NavigationMenuItem>
5363
+ </NavigationMenuList>
5364
+ </NavigationMenu>
5365
+ </div>
5366
+
5367
+ ```tsx
5368
+ import {
5369
+ NavigationMenu,
5370
+ NavigationMenuContent,
5371
+ NavigationMenuItem,
5372
+ NavigationMenuLink,
5373
+ NavigationMenuList,
5374
+ NavigationMenuTrigger,
5375
+ } from "@vercel/geistdocs/components/navigation-menu";
5376
+ ```
5377
+
5378
+ The subpath also exports `NavigationMenuIndicator`, `NavigationMenuViewport`, and `navigationMenuTriggerStyle`.
5379
+
5380
+
4704
5381
  ---
4705
5382
 
4706
5383
  ---
@@ -4787,6 +5464,48 @@ Each platform has its own integration:
4787
5464
  3. **Platform flexibility**: Teams can support different AI preferences.
4788
5465
 
4789
5466
 
5467
+ ---
5468
+
5469
+ ---
5470
+ title: Popover
5471
+ description: Render anchored floating content
5472
+ type: reference
5473
+ summary: Compose Popover, PopoverTrigger, and PopoverContent outside MDX.
5474
+ url: /docs/components/popover
5475
+ source: apps/template/content/docs/components/popover.mdx
5476
+ related:
5477
+ - /docs/components
5478
+ - /docs/components/tooltip
5479
+ ---
5480
+
5481
+ # Popover
5482
+
5483
+ import {
5484
+ Popover,
5485
+ PopoverContent,
5486
+ PopoverTrigger,
5487
+ } from "@vercel/geistdocs/components/popover";
5488
+
5489
+ <div className="not-prose my-6 flex min-h-32 items-center justify-center rounded-lg border border-gray-400 bg-background-100 p-6">
5490
+ <Popover>
5491
+ <PopoverTrigger className="h-8 rounded-md border border-gray-400 bg-background-100 px-3">
5492
+ Open popover
5493
+ </PopoverTrigger>
5494
+ <PopoverContent>Additional context for this setting.</PopoverContent>
5495
+ </Popover>
5496
+ </div>
5497
+
5498
+ ```tsx
5499
+ import {
5500
+ Popover,
5501
+ PopoverContent,
5502
+ PopoverTrigger,
5503
+ } from "@vercel/geistdocs/components/popover";
5504
+ ```
5505
+
5506
+ Use a tooltip for short contextual labels and a popover for interactive or structured content.
5507
+
5508
+
4790
5509
  ---
4791
5510
 
4792
5511
  ---
@@ -4905,6 +5624,50 @@ lastModified: 2025-11-12
4905
5624
  Git commit dates require full git history at build time. On Vercel, set the `VERCEL_DEEP_CLONE=true` environment variable so builds clone the full history. Read [Last modified dates](/docs/configuration#last-modified-dates) for the full resolution order.
4906
5625
 
4907
5626
 
5627
+ ---
5628
+
5629
+ ---
5630
+ title: Scroll Area
5631
+ description: Render styled overflow regions and scrollbars
5632
+ type: reference
5633
+ summary: Compose ScrollArea and ScrollBar for constrained custom interfaces.
5634
+ url: /docs/components/scroll-area
5635
+ source: apps/template/content/docs/components/scroll-area.mdx
5636
+ related:
5637
+ - /docs/components
5638
+ ---
5639
+
5640
+ # Scroll Area
5641
+
5642
+ import {
5643
+ ScrollArea,
5644
+ ScrollBar,
5645
+ } from "@vercel/geistdocs/components/scroll-area";
5646
+
5647
+ <div className="not-prose my-6 flex min-h-48 items-center justify-center rounded-lg border border-gray-400 bg-background-100 p-6">
5648
+ <ScrollArea className="h-32 w-full max-w-sm rounded-md border border-gray-400 p-4">
5649
+ <div className="space-y-3">
5650
+ <p>Overview</p>
5651
+ <p>Installation</p>
5652
+ <p>Configuration</p>
5653
+ <p>Deployment</p>
5654
+ <p>Troubleshooting</p>
5655
+ <p>Reference</p>
5656
+ </div>
5657
+ <ScrollBar />
5658
+ </ScrollArea>
5659
+ </div>
5660
+
5661
+ ```tsx
5662
+ import {
5663
+ ScrollArea,
5664
+ ScrollBar,
5665
+ } from "@vercel/geistdocs/components/scroll-area";
5666
+ ```
5667
+
5668
+ Keep keyboard and native scrolling available; use the component to style overflow rather than to replace browser scrolling behavior.
5669
+
5670
+
4908
5671
  ---
4909
5672
 
4910
5673
  ---
@@ -5103,6 +5866,204 @@ On mobile, Geistdocs replaces the sidebar outline with a compact menu in the pag
5103
5866
  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.
5104
5867
 
5105
5868
 
5869
+ ---
5870
+
5871
+ ---
5872
+ title: Tabs
5873
+ description: Render provider-backed tab navigation and content panels
5874
+ type: reference
5875
+ summary: Use Tabs for navigation-only controls or TabsWithChildren and TabContent for mounted content panels.
5876
+ url: /docs/components/tabs
5877
+ source: apps/template/content/docs/components/tabs.mdx
5878
+ related:
5879
+ - /docs/components
5880
+ - /docs/syntax
5881
+ ---
5882
+
5883
+ # Tabs
5884
+
5885
+ import {
5886
+ TabContent,
5887
+ TabsWithChildren,
5888
+ } from "@vercel/geistdocs/components/tabs-with-children";
5889
+
5890
+ <TabsWithChildren ariaLabel="Setup method" tabs={["Dashboard", "CLI"]}>
5891
+ <TabContent className="mt-4 text-copy-14" order={1}>
5892
+ Configure the project in the dashboard.
5893
+ </TabContent>
5894
+ <TabContent className="mt-4 text-copy-14" order={2}>
5895
+ Run the setup command in your terminal.
5896
+ </TabContent>
5897
+ </TabsWithChildren>
5898
+
5899
+ ```tsx
5900
+ import {
5901
+ TabContent,
5902
+ TabsWithChildren,
5903
+ } from "@vercel/geistdocs/components/tabs-with-children";
5904
+
5905
+ <TabsWithChildren ariaLabel="Setup method" tabs={["Dashboard", "CLI"]}>
5906
+ <TabContent className="mt-4 text-copy-14" order={1}>
5907
+ Configure the project in the dashboard.
5908
+ </TabContent>
5909
+ <TabContent className="mt-4 text-copy-14" order={2}>
5910
+ Run the setup command in your terminal.
5911
+ </TabContent>
5912
+ </TabsWithChildren>;
5913
+ ```
5914
+
5915
+ `TabsWithChildren` associates labels with `TabContent` panels by order. Inactive content remains mounted so Markdown and search exports preserve every panel.
5916
+
5917
+ For a navigation-only tab list without panels, import the lower-level `Tabs` component from `@vercel/geistdocs/components/tabs`. Both forms are available in the default MDX component map.
5918
+
5919
+
5920
+ ---
5921
+
5922
+ ---
5923
+ title: Theme Switcher
5924
+ description: Select the system, light, or dark display theme
5925
+ type: reference
5926
+ summary: Use ThemeSwitcher in custom navigation, settings, and footer UI.
5927
+ url: /docs/components/theme-switcher
5928
+ source: apps/template/content/docs/components/theme-switcher.mdx
5929
+ related:
5930
+ - /docs/components
5931
+ ---
5932
+
5933
+ # Theme Switcher
5934
+
5935
+ import { ThemeSwitcher } from "@vercel/geistdocs/components/theme-switcher";
5936
+
5937
+ <div className="not-prose my-6 flex min-h-32 items-center justify-center rounded-lg border border-gray-400 bg-background-100 p-6">
5938
+ <ThemeSwitcher />
5939
+ </div>
5940
+
5941
+ ```tsx
5942
+ import { ThemeSwitcher } from "@vercel/geistdocs/components/theme-switcher";
5943
+
5944
+ export function DisplaySettings() {
5945
+ return <ThemeSwitcher />;
5946
+ }
5947
+ ```
5948
+
5949
+ Use the compact variant where space is limited:
5950
+
5951
+ ```tsx
5952
+ <ThemeSwitcher small />
5953
+ ```
5954
+
5955
+
5956
+ ---
5957
+
5958
+ ---
5959
+ title: Toggle
5960
+ description: Render controlled boolean controls
5961
+ type: reference
5962
+ summary: Toggle is the provider-backed replacement for the former Switch export.
5963
+ url: /docs/components/toggle
5964
+ source: apps/template/content/docs/components/toggle.mdx
5965
+ related:
5966
+ - /docs/components
5967
+ - /docs/components/input
5968
+ ---
5969
+
5970
+ # Toggle
5971
+
5972
+ import { ToggleDemo } from "@/components/geistdocs/toggle-demo";
5973
+
5974
+ <div className="not-prose my-6 flex min-h-32 items-center justify-center rounded-lg border border-gray-400 bg-background-100 p-6">
5975
+ <ToggleDemo />
5976
+ </div>
5977
+
5978
+ ```tsx
5979
+ "use client";
5980
+
5981
+ import { Toggle } from "@vercel/geistdocs/components/toggle";
5982
+ import { useState } from "react";
5983
+
5984
+ export function Setting() {
5985
+ const [enabled, setEnabled] = useState(false);
5986
+ return (
5987
+ <Toggle checked={enabled} onChange={setEnabled}>
5988
+ Enable previews
5989
+ </Toggle>
5990
+ );
5991
+ }
5992
+ ```
5993
+
5994
+ Use `Toggle` and `onChange`; the v1 `Switch` and `onCheckedChange` names are not exported in Geistdocs v2.
5995
+
5996
+
5997
+ ---
5998
+
5999
+ ---
6000
+ title: Tooltip
6001
+ description: Add contextual labels on hover and focus
6002
+ type: reference
6003
+ summary: Wrap controls with provider-backed Tooltip content outside MDX.
6004
+ url: /docs/components/tooltip
6005
+ source: apps/template/content/docs/components/tooltip.mdx
6006
+ related:
6007
+ - /docs/components
6008
+ ---
6009
+
6010
+ # Tooltip
6011
+
6012
+ import { Tooltip } from "@vercel/geistdocs/components/tooltip";
6013
+
6014
+ <div className="not-prose my-6 flex min-h-32 items-center justify-center rounded-lg border border-gray-400 bg-background-100 p-6">
6015
+ <Tooltip position="top" text="Copy to clipboard">
6016
+ <button className="h-8 rounded-md border border-gray-400 bg-background-100 px-3" type="button">
6017
+ Hover or focus
6018
+ </button>
6019
+ </Tooltip>
6020
+ </div>
6021
+
6022
+ ```tsx
6023
+ import { Tooltip } from "@vercel/geistdocs/components/tooltip";
6024
+
6025
+ export function Help() {
6026
+ return (
6027
+ <Tooltip position="top" text="Copy to clipboard">
6028
+ <button type="button">Copy</button>
6029
+ </Tooltip>
6030
+ );
6031
+ }
6032
+ ```
6033
+
6034
+ Provide an accessible name on icon-only triggers independently of the tooltip text.
6035
+
6036
+
6037
+ ---
6038
+
6039
+ ---
6040
+ title: Video
6041
+ description: Render responsive video playback in documentation content
6042
+ type: reference
6043
+ summary: Use Video for embedded video sources inside React UI or authored MDX.
6044
+ url: /docs/components/video
6045
+ source: apps/template/content/docs/components/video.mdx
6046
+ related:
6047
+ - /docs/components
6048
+ ---
6049
+
6050
+ # Video
6051
+
6052
+ import { Video } from "@vercel/geistdocs/components/video";
6053
+
6054
+ <Video src="https://interactive-examples.mdn.mozilla.net/media/cc0-videos/flower.mp4" />
6055
+
6056
+ ```tsx
6057
+ import { Video } from "@vercel/geistdocs/components/video";
6058
+
6059
+ export function Demo() {
6060
+ return <Video src="https://example.com/demo.mp4" />;
6061
+ }
6062
+ ```
6063
+
6064
+ `Video` is also included in the default MDX component map.
6065
+
6066
+
5106
6067
  ---
5107
6068
 
5108
6069
  ---