@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.
- package/dist/cli/index.js +1 -1
- package/dist/internal/github-button.d.ts.map +1 -1
- package/dist/internal/github-button.js +2 -1
- package/dist/providers/public/components/badge.d.ts +13 -6
- package/dist/providers/public/components/badge.d.ts.map +1 -1
- package/dist/providers/public/components/badge.js +54 -9
- package/dist/providers/public/components/code-block-server.d.ts.map +1 -1
- package/dist/providers/public/components/code-block-server.js +13 -3
- package/dist/providers/public/components/filename-icon.d.ts +3 -0
- package/dist/providers/public/components/filename-icon.d.ts.map +1 -0
- package/dist/providers/public/components/filename-icon.js +13 -0
- package/dist/providers/public/components/input.d.ts +27 -0
- package/dist/providers/public/components/input.d.ts.map +1 -0
- package/dist/providers/public/components/input.js +27 -0
- package/dist/providers/public/components/theme-switcher.d.ts +5 -1
- package/dist/providers/public/components/theme-switcher.d.ts.map +1 -1
- package/dist/providers/public/components/theme-switcher.js +7 -3
- package/dist/providers/public/components/toggle.d.ts +26 -0
- package/dist/providers/public/components/toggle.d.ts.map +1 -0
- package/dist/providers/public/components/toggle.js +53 -0
- package/dist/providers/public/components/tooltip.d.ts +33 -7
- package/dist/providers/public/components/tooltip.d.ts.map +1 -1
- package/dist/providers/public/components/tooltip.js +19 -1
- package/dist/providers/public-assets/icons.d.ts +1 -0
- package/dist/providers/public-assets/icons.d.ts.map +1 -1
- package/dist/providers/public-assets/icons.js +1 -0
- package/docs/agents.md +25 -2
- package/docs/llms.txt +975 -14
- package/docs/manifest.json +211 -4
- package/docs/pages/components/badge.md +30 -0
- package/docs/pages/components/button.md +28 -0
- package/docs/pages/components/callout.md +28 -0
- package/docs/pages/components/code-block-tabs.md +49 -0
- package/docs/pages/components/code-block.md +26 -0
- package/docs/pages/components/collapsible.md +38 -0
- package/docs/pages/components/command-prompt.md +59 -0
- package/docs/pages/components/copy-prompt.md +25 -0
- package/docs/pages/components/details.md +37 -0
- package/docs/pages/components/dropdown-menu.md +43 -0
- package/docs/pages/components/image.md +36 -0
- package/docs/pages/components/index.md +49 -0
- package/docs/pages/components/input.md +35 -0
- package/docs/pages/components/link.md +28 -0
- package/docs/pages/components/mermaid.md +29 -0
- package/docs/pages/components/navigation-menu.md +50 -0
- package/docs/pages/components/popover.md +38 -0
- package/docs/pages/components/scroll-area.md +40 -0
- package/docs/pages/components/tabs.md +47 -0
- package/docs/pages/components/theme-switcher.md +32 -0
- package/docs/pages/components/toggle.md +37 -0
- package/docs/pages/components/tooltip.md +36 -0
- package/docs/pages/components/video.md +26 -0
- package/docs/pages/index.md +1 -1
- package/docs/pages/migration.md +4 -4
- package/docs/pages/syntax.md +7 -7
- package/docs/sitemap.md +24 -1
- package/package.json +29 -1
- package/public-foundation.css +1 -1
- package/template/components/geistdocs/toggle-demo.tsx +14 -0
- package/template/content/docs/components/badge.mdx +26 -0
- package/template/content/docs/components/button.mdx +24 -0
- package/template/content/docs/components/callout.mdx +24 -0
- package/template/content/docs/components/code-block-tabs.mdx +45 -0
- package/template/content/docs/components/code-block.mdx +22 -0
- package/template/content/docs/components/collapsible.mdx +34 -0
- package/template/content/docs/components/command-prompt.mdx +55 -0
- package/template/content/docs/components/copy-prompt.mdx +23 -0
- package/template/content/docs/components/details.mdx +33 -0
- package/template/content/docs/components/dropdown-menu.mdx +39 -0
- package/template/content/docs/components/image.mdx +32 -0
- package/template/content/docs/components/index.mdx +45 -0
- package/template/content/docs/components/input.mdx +31 -0
- package/template/content/docs/components/link.mdx +24 -0
- package/template/content/docs/components/mermaid.mdx +25 -0
- package/template/content/docs/components/meta.json +25 -1
- package/template/content/docs/components/navigation-menu.mdx +46 -0
- package/template/content/docs/components/popover.mdx +34 -0
- package/template/content/docs/components/scroll-area.mdx +36 -0
- package/template/content/docs/components/tabs.mdx +43 -0
- package/template/content/docs/components/theme-switcher.mdx +28 -0
- package/template/content/docs/components/toggle.mdx +33 -0
- package/template/content/docs/components/tooltip.mdx +32 -0
- package/template/content/docs/components/video.mdx +22 -0
- package/template/content/docs/index.mdx +1 -1
- package/template/content/docs/meta.json +1 -1
- package/template/content/docs/migration.mdx +4 -4
- package/template/content/docs/syntax.cn.mdx +3 -3
- package/template/content/docs/syntax.mdx +7 -7
- package/template/package.json +1 -1
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Popover
|
|
3
|
+
description: Render anchored floating content
|
|
4
|
+
type: reference
|
|
5
|
+
summary: Compose Popover, PopoverTrigger, and PopoverContent outside MDX.
|
|
6
|
+
related:
|
|
7
|
+
- /docs/components
|
|
8
|
+
- /docs/components/tooltip
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
import {
|
|
12
|
+
Popover,
|
|
13
|
+
PopoverContent,
|
|
14
|
+
PopoverTrigger,
|
|
15
|
+
} from "@vercel/geistdocs/components/popover";
|
|
16
|
+
|
|
17
|
+
<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">
|
|
18
|
+
<Popover>
|
|
19
|
+
<PopoverTrigger className="h-8 rounded-md border border-gray-400 bg-background-100 px-3">
|
|
20
|
+
Open popover
|
|
21
|
+
</PopoverTrigger>
|
|
22
|
+
<PopoverContent>Additional context for this setting.</PopoverContent>
|
|
23
|
+
</Popover>
|
|
24
|
+
</div>
|
|
25
|
+
|
|
26
|
+
```tsx
|
|
27
|
+
import {
|
|
28
|
+
Popover,
|
|
29
|
+
PopoverContent,
|
|
30
|
+
PopoverTrigger,
|
|
31
|
+
} from "@vercel/geistdocs/components/popover";
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Use a tooltip for short contextual labels and a popover for interactive or structured content.
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Scroll Area
|
|
3
|
+
description: Render styled overflow regions and scrollbars
|
|
4
|
+
type: reference
|
|
5
|
+
summary: Compose ScrollArea and ScrollBar for constrained custom interfaces.
|
|
6
|
+
related:
|
|
7
|
+
- /docs/components
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
import {
|
|
11
|
+
ScrollArea,
|
|
12
|
+
ScrollBar,
|
|
13
|
+
} from "@vercel/geistdocs/components/scroll-area";
|
|
14
|
+
|
|
15
|
+
<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">
|
|
16
|
+
<ScrollArea className="h-32 w-full max-w-sm rounded-md border border-gray-400 p-4">
|
|
17
|
+
<div className="space-y-3">
|
|
18
|
+
<p>Overview</p>
|
|
19
|
+
<p>Installation</p>
|
|
20
|
+
<p>Configuration</p>
|
|
21
|
+
<p>Deployment</p>
|
|
22
|
+
<p>Troubleshooting</p>
|
|
23
|
+
<p>Reference</p>
|
|
24
|
+
</div>
|
|
25
|
+
<ScrollBar />
|
|
26
|
+
</ScrollArea>
|
|
27
|
+
</div>
|
|
28
|
+
|
|
29
|
+
```tsx
|
|
30
|
+
import {
|
|
31
|
+
ScrollArea,
|
|
32
|
+
ScrollBar,
|
|
33
|
+
} from "@vercel/geistdocs/components/scroll-area";
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Keep keyboard and native scrolling available; use the component to style overflow rather than to replace browser scrolling behavior.
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Tabs
|
|
3
|
+
description: Render provider-backed tab navigation and content panels
|
|
4
|
+
type: reference
|
|
5
|
+
summary: Use Tabs for navigation-only controls or TabsWithChildren and TabContent for mounted content panels.
|
|
6
|
+
related:
|
|
7
|
+
- /docs/components
|
|
8
|
+
- /docs/syntax
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
import {
|
|
12
|
+
TabContent,
|
|
13
|
+
TabsWithChildren,
|
|
14
|
+
} from "@vercel/geistdocs/components/tabs-with-children";
|
|
15
|
+
|
|
16
|
+
<TabsWithChildren ariaLabel="Setup method" tabs={["Dashboard", "CLI"]}>
|
|
17
|
+
<TabContent className="mt-4 text-copy-14" order={1}>
|
|
18
|
+
Configure the project in the dashboard.
|
|
19
|
+
</TabContent>
|
|
20
|
+
<TabContent className="mt-4 text-copy-14" order={2}>
|
|
21
|
+
Run the setup command in your terminal.
|
|
22
|
+
</TabContent>
|
|
23
|
+
</TabsWithChildren>
|
|
24
|
+
|
|
25
|
+
```tsx
|
|
26
|
+
import {
|
|
27
|
+
TabContent,
|
|
28
|
+
TabsWithChildren,
|
|
29
|
+
} from "@vercel/geistdocs/components/tabs-with-children";
|
|
30
|
+
|
|
31
|
+
<TabsWithChildren ariaLabel="Setup method" tabs={["Dashboard", "CLI"]}>
|
|
32
|
+
<TabContent className="mt-4 text-copy-14" order={1}>
|
|
33
|
+
Configure the project in the dashboard.
|
|
34
|
+
</TabContent>
|
|
35
|
+
<TabContent className="mt-4 text-copy-14" order={2}>
|
|
36
|
+
Run the setup command in your terminal.
|
|
37
|
+
</TabContent>
|
|
38
|
+
</TabsWithChildren>;
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
`TabsWithChildren` associates labels with `TabContent` panels by order. Inactive content remains mounted so Markdown and search exports preserve every panel.
|
|
42
|
+
|
|
43
|
+
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.
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Theme Switcher
|
|
3
|
+
description: Select the system, light, or dark display theme
|
|
4
|
+
type: reference
|
|
5
|
+
summary: Use ThemeSwitcher in custom navigation, settings, and footer UI.
|
|
6
|
+
related:
|
|
7
|
+
- /docs/components
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
import { ThemeSwitcher } from "@vercel/geistdocs/components/theme-switcher";
|
|
11
|
+
|
|
12
|
+
<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">
|
|
13
|
+
<ThemeSwitcher />
|
|
14
|
+
</div>
|
|
15
|
+
|
|
16
|
+
```tsx
|
|
17
|
+
import { ThemeSwitcher } from "@vercel/geistdocs/components/theme-switcher";
|
|
18
|
+
|
|
19
|
+
export function DisplaySettings() {
|
|
20
|
+
return <ThemeSwitcher />;
|
|
21
|
+
}
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Use the compact variant where space is limited:
|
|
25
|
+
|
|
26
|
+
```tsx
|
|
27
|
+
<ThemeSwitcher small />
|
|
28
|
+
```
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Toggle
|
|
3
|
+
description: Render controlled boolean controls
|
|
4
|
+
type: reference
|
|
5
|
+
summary: Toggle is the provider-backed replacement for the former Switch export.
|
|
6
|
+
related:
|
|
7
|
+
- /docs/components
|
|
8
|
+
- /docs/components/input
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
import { ToggleDemo } from "@/components/geistdocs/toggle-demo";
|
|
12
|
+
|
|
13
|
+
<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">
|
|
14
|
+
<ToggleDemo />
|
|
15
|
+
</div>
|
|
16
|
+
|
|
17
|
+
```tsx
|
|
18
|
+
"use client";
|
|
19
|
+
|
|
20
|
+
import { Toggle } from "@vercel/geistdocs/components/toggle";
|
|
21
|
+
import { useState } from "react";
|
|
22
|
+
|
|
23
|
+
export function Setting() {
|
|
24
|
+
const [enabled, setEnabled] = useState(false);
|
|
25
|
+
return (
|
|
26
|
+
<Toggle checked={enabled} onChange={setEnabled}>
|
|
27
|
+
Enable previews
|
|
28
|
+
</Toggle>
|
|
29
|
+
);
|
|
30
|
+
}
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Use `Toggle` and `onChange`; the v1 `Switch` and `onCheckedChange` names are not exported in Geistdocs v2.
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Tooltip
|
|
3
|
+
description: Add contextual labels on hover and focus
|
|
4
|
+
type: reference
|
|
5
|
+
summary: Wrap controls with provider-backed Tooltip content outside MDX.
|
|
6
|
+
related:
|
|
7
|
+
- /docs/components
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
import { Tooltip } from "@vercel/geistdocs/components/tooltip";
|
|
11
|
+
|
|
12
|
+
<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">
|
|
13
|
+
<Tooltip position="top" text="Copy to clipboard">
|
|
14
|
+
<button className="h-8 rounded-md border border-gray-400 bg-background-100 px-3" type="button">
|
|
15
|
+
Hover or focus
|
|
16
|
+
</button>
|
|
17
|
+
</Tooltip>
|
|
18
|
+
</div>
|
|
19
|
+
|
|
20
|
+
```tsx
|
|
21
|
+
import { Tooltip } from "@vercel/geistdocs/components/tooltip";
|
|
22
|
+
|
|
23
|
+
export function Help() {
|
|
24
|
+
return (
|
|
25
|
+
<Tooltip position="top" text="Copy to clipboard">
|
|
26
|
+
<button type="button">Copy</button>
|
|
27
|
+
</Tooltip>
|
|
28
|
+
);
|
|
29
|
+
}
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Provide an accessible name on icon-only triggers independently of the tooltip text.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Video
|
|
3
|
+
description: Render responsive video playback in documentation content
|
|
4
|
+
type: reference
|
|
5
|
+
summary: Use Video for embedded video sources inside React UI or authored MDX.
|
|
6
|
+
related:
|
|
7
|
+
- /docs/components
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
import { Video } from "@vercel/geistdocs/components/video";
|
|
11
|
+
|
|
12
|
+
<Video src="https://interactive-examples.mdn.mozilla.net/media/cc0-videos/flower.mp4" />
|
|
13
|
+
|
|
14
|
+
```tsx
|
|
15
|
+
import { Video } from "@vercel/geistdocs/components/video";
|
|
16
|
+
|
|
17
|
+
export function Demo() {
|
|
18
|
+
return <Video src="https://example.com/demo.mp4" />;
|
|
19
|
+
}
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
`Video` is also included in the default MDX component map.
|
|
@@ -95,4 +95,4 @@ Advanced projects can use package APIs for versioned docs, multiple content sour
|
|
|
95
95
|
- Read [Configuration](/docs/configuration) to customize the generated site.
|
|
96
96
|
- Read [Versioned docs](/docs/versioned-docs) to configure multiple docs versions.
|
|
97
97
|
- Read [Proxy and markdown routes](/docs/proxy) to add custom request logic.
|
|
98
|
-
- Read [
|
|
98
|
+
- Read [MDX Components](/docs/syntax) to author content with the default component map.
|
|
@@ -110,12 +110,12 @@ Replace imports according to this table:
|
|
|
110
110
|
|
|
111
111
|
| Previous Geistdocs import | Replacement |
|
|
112
112
|
| --- | --- |
|
|
113
|
-
| `components/badge`, `components/button`,
|
|
114
|
-
| `components/dialog`, `components/drawer`, `components/
|
|
115
|
-
| `components/switch` |
|
|
113
|
+
| `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. |
|
|
114
|
+
| `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. |
|
|
115
|
+
| `components/switch` | Replace `Switch` with package-backed `Toggle` from `components/toggle`, and replace `onCheckedChange` with `onChange`. |
|
|
116
116
|
| `components/sonner` | Use `Toasts` and `useToasts` from `@vercel/geistcn/components/toasts`. |
|
|
117
117
|
| `components/theme-aware-image` | Use `Image` from `@vercel/geistcn/components/image` with `srcLight` and `srcDark`. |
|
|
118
|
-
| `assets/icons`, `assets/icons/*`, `assets/logos`, or `assets/logos/*` |
|
|
118
|
+
| `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. |
|
|
119
119
|
| `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. |
|
|
120
120
|
|
|
121
121
|
Keep documentation-specific composites such as `Callout`, `CodeBlock`, `CodeBlockTabs`, `CommandPrompt`, `CopyPrompt`, and `Mermaid` imported from `@vercel/geistdocs/components/*`.
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
---
|
|
2
|
-
title:
|
|
3
|
-
description:
|
|
2
|
+
title: MDX 组件
|
|
3
|
+
description: 使用支持的组件、Markdown 语法和格式选项编写 MDX 内容
|
|
4
4
|
type: reference
|
|
5
|
-
summary:
|
|
5
|
+
summary: MDX 组件和编写参考,包括文本格式、代码块、行高亮和 Mermaid 图表。
|
|
6
6
|
prerequisites:
|
|
7
7
|
- /docs/getting-started
|
|
8
8
|
related:
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
---
|
|
2
|
-
title:
|
|
3
|
-
description:
|
|
2
|
+
title: MDX Components
|
|
3
|
+
description: Author MDX content with supported components, Markdown syntax, and formatting options
|
|
4
4
|
type: reference
|
|
5
|
-
summary:
|
|
5
|
+
summary: MDX component and authoring reference covering tabs, text formatting, code blocks, line highlighting, and Mermaid diagrams.
|
|
6
6
|
prerequisites:
|
|
7
7
|
- /docs/getting-started
|
|
8
8
|
related:
|
|
@@ -11,10 +11,10 @@ related:
|
|
|
11
11
|
|
|
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
|
-
<CopyPrompt text="Help me write a Geistdocs MDX page. Use this page as
|
|
15
|
-
Help me write a Geistdocs MDX page. Use this page as
|
|
16
|
-
create an example page with frontmatter, headings, links, a
|
|
17
|
-
`Callout`, and a `CopyPrompt` component.
|
|
14
|
+
<CopyPrompt text="Help me write a Geistdocs MDX page. Use this page as an MDX component 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 an MDX component
|
|
16
|
+
reference and create an example page with frontmatter, headings, links, a
|
|
17
|
+
code block, a `Callout`, and a `CopyPrompt` component.
|
|
18
18
|
</CopyPrompt>
|
|
19
19
|
|
|
20
20
|
## Frontmatter
|
package/template/package.json
CHANGED