@vercel/geistdocs 1.25.1-canary.c58830e → 1.25.1-canary.eec231d
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.js +1 -1
- package/dist/components/callout.d.ts +13 -10
- package/dist/components/callout.d.ts.map +1 -1
- package/dist/components/callout.js +6 -6
- package/dist/components/code-block-tabs.d.ts.map +1 -1
- package/dist/components/code-block-tabs.js +3 -1
- package/dist/components/code-block.d.ts.map +1 -1
- package/dist/components/code-block.js +1 -1
- package/dist/components/command-prompt.d.ts.map +1 -1
- package/dist/components/command-prompt.js +15 -22
- package/dist/components/copy-prompt.d.ts +2 -1
- package/dist/components/copy-prompt.d.ts.map +1 -1
- package/dist/components/copy-prompt.js +2 -2
- package/dist/components/heading.d.ts +7 -0
- package/dist/components/heading.d.ts.map +1 -0
- package/dist/components/heading.js +14 -0
- package/dist/components/table.d.ts +3 -0
- package/dist/components/table.d.ts.map +1 -0
- package/dist/components/table.js +3 -0
- package/dist/controls.d.ts.map +1 -1
- package/dist/controls.js +4 -3
- package/dist/internal/chat/context.d.ts +2 -0
- package/dist/internal/chat/context.d.ts.map +1 -1
- package/dist/internal/chat/context.js +24 -3
- package/dist/internal/chat/dots-spinner.d.ts.map +1 -1
- package/dist/internal/chat/dots-spinner.js +15 -9
- package/dist/internal/chat/loading-skeleton.d.ts +7 -0
- package/dist/internal/chat/loading-skeleton.d.ts.map +1 -0
- package/dist/internal/chat/loading-skeleton.js +46 -0
- package/dist/internal/chat/message.d.ts.map +1 -1
- package/dist/internal/chat/message.js +23 -3
- package/dist/internal/chat/shell.d.ts.map +1 -1
- package/dist/internal/chat/shell.js +10 -15
- package/dist/internal/chat/sources.d.ts.map +1 -1
- package/dist/internal/chat/sources.js +4 -1
- package/dist/internal/navbar/desktop-menu.js +1 -1
- package/dist/internal/navbar/mobile-menu.d.ts.map +1 -1
- package/dist/internal/navbar/mobile-menu.js +8 -13
- package/dist/internal/page-actions-client.d.ts.map +1 -1
- package/dist/internal/page-actions-client.js +36 -32
- package/dist/internal/provider-client.d.ts.map +1 -1
- package/dist/internal/provider-client.js +39 -5
- package/dist/internal/search.d.ts.map +1 -1
- package/dist/internal/search.js +1 -1
- package/dist/internal/sidebar-responsive.d.ts +0 -1
- package/dist/internal/sidebar-responsive.d.ts.map +1 -1
- package/dist/internal/sidebar-responsive.js +0 -9
- package/dist/internal/sidebar.d.ts.map +1 -1
- package/dist/internal/sidebar.js +63 -35
- package/dist/internal/table-of-contents.d.ts.map +1 -1
- package/dist/internal/table-of-contents.js +1 -1
- package/dist/internal/toc-items.d.ts.map +1 -1
- package/dist/internal/toc-items.js +16 -6
- package/dist/internal/ui/dropdown-menu.js +6 -6
- package/dist/internal/ui/navigation-menu.js +2 -2
- package/dist/internal/use-mobile.d.ts.map +1 -1
- package/dist/internal/use-mobile.js +2 -12
- package/dist/layout.d.ts +1 -0
- package/dist/layout.d.ts.map +1 -1
- package/dist/layout.js +2 -0
- package/dist/mdx.d.ts.map +1 -1
- package/dist/mdx.js +11 -4
- package/dist/pages/docs.d.ts.map +1 -1
- package/dist/pages/docs.js +6 -4
- package/dist/routes/chat.d.ts +1 -1
- package/dist/routes/chat.js +1 -1
- package/dist/versions.js +2 -2
- package/docs/agents.md +1 -1
- package/docs/llms.txt +110 -12
- package/docs/manifest.json +1 -1
- package/docs/pages/ask-ai.md +2 -2
- package/docs/pages/md.md +1 -1
- package/docs/pages/syntax.md +106 -8
- package/package.json +2 -1
- package/template/app/[lang]/layout.tsx +4 -0
- package/template/app/styles/geistdocs.css +1 -1
- package/template/components/ui/button.tsx +1 -1
- package/template/content/docs/ask-ai.cn.mdx +2 -2
- package/template/content/docs/ask-ai.mdx +2 -2
- package/template/content/docs/md.mdx +1 -1
- package/template/content/docs/syntax.mdx +112 -8
- package/template/package.json +1 -1
- package/theme.css +39 -101
package/docs/llms.txt
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Geistdocs Package Documentation
|
|
2
2
|
|
|
3
|
-
These docs are bundled with `@vercel/geistdocs` 1.25.1-canary.
|
|
3
|
+
These docs are bundled with `@vercel/geistdocs` 1.25.1-canary.eec231d.
|
|
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
|
|
@@ -1256,11 +1256,17 @@ Headings automatically generate anchor links for navigation and deep linking.
|
|
|
1256
1256
|
|
|
1257
1257
|
Create unordered lists with `-`, `*`, or `+`:
|
|
1258
1258
|
|
|
1259
|
-
|
|
1260
|
-
-
|
|
1261
|
-
|
|
1262
|
-
|
|
1263
|
-
|
|
1259
|
+
```md
|
|
1260
|
+
- Install the required packages
|
|
1261
|
+
- Configure your project
|
|
1262
|
+
- Start the development server
|
|
1263
|
+
```
|
|
1264
|
+
|
|
1265
|
+
This renders as:
|
|
1266
|
+
|
|
1267
|
+
- Install the required packages
|
|
1268
|
+
- Configure your project
|
|
1269
|
+
- Start the development server
|
|
1264
1270
|
|
|
1265
1271
|
Create ordered lists with numbers:
|
|
1266
1272
|
|
|
@@ -1286,6 +1292,78 @@ This renders as:
|
|
|
1286
1292
|
|
|
1287
1293
|
> This is automatically set when deploying to Vercel.
|
|
1288
1294
|
|
|
1295
|
+
Callouts can also contain a title and lists:
|
|
1296
|
+
|
|
1297
|
+
> Note:
|
|
1298
|
+
- The `App Router` uses [React canary
|
|
1299
|
+
releases](https://react.dev/blog/2023/05/03/react-canaries) built-in, which
|
|
1300
|
+
include all the stable React 19 changes, as well as newer features being
|
|
1301
|
+
validated in frameworks, but you should still declare react and react-dom in
|
|
1302
|
+
package.json for tooling and ecosystem compatibility.
|
|
1303
|
+
- The `Pages Router` uses the React version from your `package.json`.
|
|
1304
|
+
|
|
1305
|
+
Callouts support rich inline Markdown, including code, emphasis, and links:
|
|
1306
|
+
|
|
1307
|
+
```mdx
|
|
1308
|
+
<Callout title="Good to know">
|
|
1309
|
+
Global styles can be imported into any layout, page, or component inside the
|
|
1310
|
+
`app` directory. However, since Next.js uses React's built-in support for
|
|
1311
|
+
stylesheets to integrate with Suspense, this currently does not remove
|
|
1312
|
+
stylesheets as you navigate between routes which can lead to conflicts. We
|
|
1313
|
+
recommend using global styles for _truly global_ CSS (like Tailwind's base
|
|
1314
|
+
styles), [Tailwind CSS](https://tailwindcss.com) for component styling, and
|
|
1315
|
+
[CSS Modules](https://nextjs.org/docs/app/getting-started/css#css-modules) for
|
|
1316
|
+
custom scoped CSS when needed.
|
|
1317
|
+
</Callout>
|
|
1318
|
+
```
|
|
1319
|
+
|
|
1320
|
+
This renders as:
|
|
1321
|
+
|
|
1322
|
+
> Note:
|
|
1323
|
+
Global styles can be imported into any layout, page, or component inside the
|
|
1324
|
+
`app` directory. However, since Next.js uses React's built-in support for
|
|
1325
|
+
stylesheets to integrate with Suspense, this currently does not remove
|
|
1326
|
+
stylesheets as you navigate between routes which can lead to conflicts. We
|
|
1327
|
+
recommend using global styles for _truly global_ CSS (like Tailwind's base
|
|
1328
|
+
styles), [Tailwind CSS](https://tailwindcss.com) for component styling, and
|
|
1329
|
+
[CSS Modules](https://nextjs.org/docs/app/getting-started/css#css-modules) for
|
|
1330
|
+
custom scoped CSS when needed.
|
|
1331
|
+
|
|
1332
|
+
### Copy Prompts
|
|
1333
|
+
|
|
1334
|
+
Short prompts render in full without an expansion control:
|
|
1335
|
+
|
|
1336
|
+
```mdx
|
|
1337
|
+
<CopyPrompt text="Summarize this documentation page and list the key concepts.">
|
|
1338
|
+
Summarize this documentation page and list the key concepts.
|
|
1339
|
+
</CopyPrompt>
|
|
1340
|
+
```
|
|
1341
|
+
|
|
1342
|
+
This renders as:
|
|
1343
|
+
|
|
1344
|
+
Summarize this documentation page and list the key concepts.
|
|
1345
|
+
|
|
1346
|
+
Long prompts initially show a preview with a **Show more** control:
|
|
1347
|
+
|
|
1348
|
+
```mdx
|
|
1349
|
+
<CopyPrompt collapsible text="Write a detailed migration plan for this project.">
|
|
1350
|
+
Write a detailed migration plan for this project. Include prerequisites,
|
|
1351
|
+
implementation steps, validation, rollback guidance, and common pitfalls.
|
|
1352
|
+
</CopyPrompt>
|
|
1353
|
+
```
|
|
1354
|
+
|
|
1355
|
+
Set the boolean `collapsible` prop when the prompt should initially render as a
|
|
1356
|
+
two-line preview. This renders as:
|
|
1357
|
+
|
|
1358
|
+
Review this Geistdocs project in detail. Explain how the `@vercel/geistdocs`
|
|
1359
|
+
package, application layouts, local adapter files, source configuration,
|
|
1360
|
+
`content/docs` directory, navigation metadata, MDX components, syntax
|
|
1361
|
+
highlighting, search routes, and deployment configuration work together.
|
|
1362
|
+
Then identify the safest first files to edit, describe the effect of each
|
|
1363
|
+
change, call out common mistakes, and propose a step-by-step plan for
|
|
1364
|
+
customizing the documentation site without breaking routing, generated
|
|
1365
|
+
Markdown, or accessibility behavior.
|
|
1366
|
+
|
|
1289
1367
|
### Links
|
|
1290
1368
|
|
|
1291
1369
|
Create links with `[text](url)`:
|
|
@@ -1293,15 +1371,25 @@ Create links with `[text](url)`:
|
|
|
1293
1371
|
- [External link](https://vercel.com)
|
|
1294
1372
|
- [Internal link](/docs/getting-started)
|
|
1295
1373
|
|
|
1296
|
-
Use an absolute `https://` or `http://` URL
|
|
1297
|
-
|
|
1298
|
-
|
|
1374
|
+
Use an absolute `https://` or `http://` URL for an external destination. Use a
|
|
1375
|
+
root-relative path beginning with `/` for an internal link. Both use the same
|
|
1376
|
+
visual styling:
|
|
1299
1377
|
|
|
1300
1378
|
```md
|
|
1301
1379
|
[External link](https://vercel.com)
|
|
1302
1380
|
[Internal link](/docs/getting-started)
|
|
1303
1381
|
```
|
|
1304
1382
|
|
|
1383
|
+
Links can also contain inline code:
|
|
1384
|
+
|
|
1385
|
+
```md
|
|
1386
|
+
Run independent requests in parallel with [`Promise.all`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise/all).
|
|
1387
|
+
```
|
|
1388
|
+
|
|
1389
|
+
This renders as:
|
|
1390
|
+
|
|
1391
|
+
Run independent requests in parallel with [`Promise.all`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise/all).
|
|
1392
|
+
|
|
1305
1393
|
### Images
|
|
1306
1394
|
|
|
1307
1395
|
Add images with ``:
|
|
@@ -1334,6 +1422,16 @@ This renders as:
|
|
|
1334
1422
|
| GFM | GitHub extensions | Supported |
|
|
1335
1423
|
| MDX | JSX in Markdown | Supported |
|
|
1336
1424
|
|
|
1425
|
+
Tables can also include inline code, as commonly used for file references:
|
|
1426
|
+
|
|
1427
|
+
| File | Description |
|
|
1428
|
+
| -------------------- | ------------------------------------------------ |
|
|
1429
|
+
| `next.config.js` | Configuration file for Next.js |
|
|
1430
|
+
| `package.json` | Project dependencies and scripts |
|
|
1431
|
+
| `instrumentation.ts` | OpenTelemetry and instrumentation file |
|
|
1432
|
+
| `.env.local` | Local environment variables |
|
|
1433
|
+
| `tsconfig.json` | Configuration file for TypeScript |
|
|
1434
|
+
|
|
1337
1435
|
### Task Lists
|
|
1338
1436
|
|
|
1339
1437
|
Create interactive task lists:
|
|
@@ -2371,7 +2469,7 @@ The `.mdx` version returns:
|
|
|
2371
2469
|
|
|
2372
2470
|
For a docs section mounted at `/docs`, the section root remains `/docs.md`. For a source mounted at the app root with `baseUrl: "/"`, Geistdocs uses `/index.md` for the root page. If Next.js has `basePath: "/docs"`, that public root Markdown URL is `/docs/index.md`.
|
|
2373
2471
|
|
|
2374
|
-
Copy Page, View as Markdown, and the `text/markdown` metadata alternate all use the same package resolver. Use `createDocsPage({ getMarkdownUrl })` only when the deployment needs a different public contract.
|
|
2472
|
+
Copy Page, View as Markdown, and the `text/markdown` metadata alternate all use the same package resolver. View as Markdown opens the resolved `.md` URL in a new tab from a button, which keeps the URL shareable without adding an anchor to the page. Use `createDocsPage({ getMarkdownUrl })` only when the deployment needs a different public contract.
|
|
2375
2473
|
|
|
2376
2474
|
## Use cases
|
|
2377
2475
|
|
|
@@ -2703,7 +2801,7 @@ In this mode, Geistdocs uses the local `search_docs` tool during the AI SDK `str
|
|
|
2703
2801
|
|
|
2704
2802
|
#### Choose a model
|
|
2705
2803
|
|
|
2706
|
-
Pass the `model` option to `createChatRoute` to control which model answers Ask AI requests. It accepts any AI SDK `LanguageModel`, including AI Gateway model strings, and defaults to `openai/gpt-
|
|
2804
|
+
Pass the `model` option to `createChatRoute` to control which model answers Ask AI requests. It accepts any AI SDK `LanguageModel`, including AI Gateway model strings, and defaults to `openai/gpt-5.6-sol`.
|
|
2707
2805
|
|
|
2708
2806
|
```ts title="app/api/chat/route.ts"
|
|
2709
2807
|
import { createChatRoute } from "@vercel/geistdocs/routes/chat";
|
|
@@ -2812,7 +2910,7 @@ The chat interface adapts to different screen sizes:
|
|
|
2812
2910
|
|
|
2813
2911
|
The environment variables `AI_GATEWAY_API_KEY` and `NEXT_PUBLIC_VERCEL_PROJECT_PRODUCTION_URL` must be set for the default AI Gateway mode. Set `GEISTDOCS_CHAT_PROXY_URL` to route Ask AI through a Vertex-backed proxy instead. You can read more in the [Environment Variables](/docs/env) section.
|
|
2814
2912
|
|
|
2815
|
-
In default AI Gateway mode, Geistdocs uses `openai/gpt-
|
|
2913
|
+
In default AI Gateway mode, Geistdocs uses `openai/gpt-5.6-sol` via the Vercel AI Gateway. In Vertex-backed proxy mode, the configured proxy controls the upstream model.
|
|
2816
2914
|
|
|
2817
2915
|
## Suggested Prompts
|
|
2818
2916
|
|
package/docs/manifest.json
CHANGED
package/docs/pages/ask-ai.md
CHANGED
|
@@ -93,7 +93,7 @@ In this mode, Geistdocs uses the local `search_docs` tool during the AI SDK `str
|
|
|
93
93
|
|
|
94
94
|
#### Choose a model
|
|
95
95
|
|
|
96
|
-
Pass the `model` option to `createChatRoute` to control which model answers Ask AI requests. It accepts any AI SDK `LanguageModel`, including AI Gateway model strings, and defaults to `openai/gpt-
|
|
96
|
+
Pass the `model` option to `createChatRoute` to control which model answers Ask AI requests. It accepts any AI SDK `LanguageModel`, including AI Gateway model strings, and defaults to `openai/gpt-5.6-sol`.
|
|
97
97
|
|
|
98
98
|
```ts title="app/api/chat/route.ts"
|
|
99
99
|
import { createChatRoute } from "@vercel/geistdocs/routes/chat";
|
|
@@ -202,7 +202,7 @@ The chat interface adapts to different screen sizes:
|
|
|
202
202
|
|
|
203
203
|
The environment variables `AI_GATEWAY_API_KEY` and `NEXT_PUBLIC_VERCEL_PROJECT_PRODUCTION_URL` must be set for the default AI Gateway mode. Set `GEISTDOCS_CHAT_PROXY_URL` to route Ask AI through a Vertex-backed proxy instead. You can read more in the [Environment Variables](/docs/env) section.
|
|
204
204
|
|
|
205
|
-
In default AI Gateway mode, Geistdocs uses `openai/gpt-
|
|
205
|
+
In default AI Gateway mode, Geistdocs uses `openai/gpt-5.6-sol` via the Vercel AI Gateway. In Vertex-backed proxy mode, the configured proxy controls the upstream model.
|
|
206
206
|
|
|
207
207
|
## Suggested Prompts
|
|
208
208
|
|
package/docs/pages/md.md
CHANGED
|
@@ -39,7 +39,7 @@ The `.mdx` version returns:
|
|
|
39
39
|
|
|
40
40
|
For a docs section mounted at `/docs`, the section root remains `/docs.md`. For a source mounted at the app root with `baseUrl: "/"`, Geistdocs uses `/index.md` for the root page. If Next.js has `basePath: "/docs"`, that public root Markdown URL is `/docs/index.md`.
|
|
41
41
|
|
|
42
|
-
Copy Page, View as Markdown, and the `text/markdown` metadata alternate all use the same package resolver. Use `createDocsPage({ getMarkdownUrl })` only when the deployment needs a different public contract.
|
|
42
|
+
Copy Page, View as Markdown, and the `text/markdown` metadata alternate all use the same package resolver. View as Markdown opens the resolved `.md` URL in a new tab from a button, which keeps the URL shareable without adding an anchor to the page. Use `createDocsPage({ getMarkdownUrl })` only when the deployment needs a different public contract.
|
|
43
43
|
|
|
44
44
|
## Use cases
|
|
45
45
|
|
package/docs/pages/syntax.md
CHANGED
|
@@ -69,11 +69,17 @@ Headings automatically generate anchor links for navigation and deep linking.
|
|
|
69
69
|
|
|
70
70
|
Create unordered lists with `-`, `*`, or `+`:
|
|
71
71
|
|
|
72
|
-
|
|
73
|
-
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
72
|
+
```md
|
|
73
|
+
- Install the required packages
|
|
74
|
+
- Configure your project
|
|
75
|
+
- Start the development server
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
This renders as:
|
|
79
|
+
|
|
80
|
+
- Install the required packages
|
|
81
|
+
- Configure your project
|
|
82
|
+
- Start the development server
|
|
77
83
|
|
|
78
84
|
Create ordered lists with numbers:
|
|
79
85
|
|
|
@@ -99,6 +105,78 @@ This renders as:
|
|
|
99
105
|
|
|
100
106
|
> This is automatically set when deploying to Vercel.
|
|
101
107
|
|
|
108
|
+
Callouts can also contain a title and lists:
|
|
109
|
+
|
|
110
|
+
> Note:
|
|
111
|
+
- The `App Router` uses [React canary
|
|
112
|
+
releases](https://react.dev/blog/2023/05/03/react-canaries) built-in, which
|
|
113
|
+
include all the stable React 19 changes, as well as newer features being
|
|
114
|
+
validated in frameworks, but you should still declare react and react-dom in
|
|
115
|
+
package.json for tooling and ecosystem compatibility.
|
|
116
|
+
- The `Pages Router` uses the React version from your `package.json`.
|
|
117
|
+
|
|
118
|
+
Callouts support rich inline Markdown, including code, emphasis, and links:
|
|
119
|
+
|
|
120
|
+
```mdx
|
|
121
|
+
<Callout title="Good to know">
|
|
122
|
+
Global styles can be imported into any layout, page, or component inside the
|
|
123
|
+
`app` directory. However, since Next.js uses React's built-in support for
|
|
124
|
+
stylesheets to integrate with Suspense, this currently does not remove
|
|
125
|
+
stylesheets as you navigate between routes which can lead to conflicts. We
|
|
126
|
+
recommend using global styles for _truly global_ CSS (like Tailwind's base
|
|
127
|
+
styles), [Tailwind CSS](https://tailwindcss.com) for component styling, and
|
|
128
|
+
[CSS Modules](https://nextjs.org/docs/app/getting-started/css#css-modules) for
|
|
129
|
+
custom scoped CSS when needed.
|
|
130
|
+
</Callout>
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
This renders as:
|
|
134
|
+
|
|
135
|
+
> Note:
|
|
136
|
+
Global styles can be imported into any layout, page, or component inside the
|
|
137
|
+
`app` directory. However, since Next.js uses React's built-in support for
|
|
138
|
+
stylesheets to integrate with Suspense, this currently does not remove
|
|
139
|
+
stylesheets as you navigate between routes which can lead to conflicts. We
|
|
140
|
+
recommend using global styles for _truly global_ CSS (like Tailwind's base
|
|
141
|
+
styles), [Tailwind CSS](https://tailwindcss.com) for component styling, and
|
|
142
|
+
[CSS Modules](https://nextjs.org/docs/app/getting-started/css#css-modules) for
|
|
143
|
+
custom scoped CSS when needed.
|
|
144
|
+
|
|
145
|
+
### Copy Prompts
|
|
146
|
+
|
|
147
|
+
Short prompts render in full without an expansion control:
|
|
148
|
+
|
|
149
|
+
```mdx
|
|
150
|
+
<CopyPrompt text="Summarize this documentation page and list the key concepts.">
|
|
151
|
+
Summarize this documentation page and list the key concepts.
|
|
152
|
+
</CopyPrompt>
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
This renders as:
|
|
156
|
+
|
|
157
|
+
Summarize this documentation page and list the key concepts.
|
|
158
|
+
|
|
159
|
+
Long prompts initially show a preview with a **Show more** control:
|
|
160
|
+
|
|
161
|
+
```mdx
|
|
162
|
+
<CopyPrompt collapsible text="Write a detailed migration plan for this project.">
|
|
163
|
+
Write a detailed migration plan for this project. Include prerequisites,
|
|
164
|
+
implementation steps, validation, rollback guidance, and common pitfalls.
|
|
165
|
+
</CopyPrompt>
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
Set the boolean `collapsible` prop when the prompt should initially render as a
|
|
169
|
+
two-line preview. This renders as:
|
|
170
|
+
|
|
171
|
+
Review this Geistdocs project in detail. Explain how the `@vercel/geistdocs`
|
|
172
|
+
package, application layouts, local adapter files, source configuration,
|
|
173
|
+
`content/docs` directory, navigation metadata, MDX components, syntax
|
|
174
|
+
highlighting, search routes, and deployment configuration work together.
|
|
175
|
+
Then identify the safest first files to edit, describe the effect of each
|
|
176
|
+
change, call out common mistakes, and propose a step-by-step plan for
|
|
177
|
+
customizing the documentation site without breaking routing, generated
|
|
178
|
+
Markdown, or accessibility behavior.
|
|
179
|
+
|
|
102
180
|
### Links
|
|
103
181
|
|
|
104
182
|
Create links with `[text](url)`:
|
|
@@ -106,15 +184,25 @@ Create links with `[text](url)`:
|
|
|
106
184
|
- [External link](https://vercel.com)
|
|
107
185
|
- [Internal link](/docs/getting-started)
|
|
108
186
|
|
|
109
|
-
Use an absolute `https://` or `http://` URL
|
|
110
|
-
|
|
111
|
-
|
|
187
|
+
Use an absolute `https://` or `http://` URL for an external destination. Use a
|
|
188
|
+
root-relative path beginning with `/` for an internal link. Both use the same
|
|
189
|
+
visual styling:
|
|
112
190
|
|
|
113
191
|
```md
|
|
114
192
|
[External link](https://vercel.com)
|
|
115
193
|
[Internal link](/docs/getting-started)
|
|
116
194
|
```
|
|
117
195
|
|
|
196
|
+
Links can also contain inline code:
|
|
197
|
+
|
|
198
|
+
```md
|
|
199
|
+
Run independent requests in parallel with [`Promise.all`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise/all).
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
This renders as:
|
|
203
|
+
|
|
204
|
+
Run independent requests in parallel with [`Promise.all`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise/all).
|
|
205
|
+
|
|
118
206
|
### Images
|
|
119
207
|
|
|
120
208
|
Add images with ``:
|
|
@@ -147,6 +235,16 @@ This renders as:
|
|
|
147
235
|
| GFM | GitHub extensions | Supported |
|
|
148
236
|
| MDX | JSX in Markdown | Supported |
|
|
149
237
|
|
|
238
|
+
Tables can also include inline code, as commonly used for file references:
|
|
239
|
+
|
|
240
|
+
| File | Description |
|
|
241
|
+
| -------------------- | ------------------------------------------------ |
|
|
242
|
+
| `next.config.js` | Configuration file for Next.js |
|
|
243
|
+
| `package.json` | Project dependencies and scripts |
|
|
244
|
+
| `instrumentation.ts` | OpenTelemetry and instrumentation file |
|
|
245
|
+
| `.env.local` | Local environment variables |
|
|
246
|
+
| `tsconfig.json` | Configuration file for TypeScript |
|
|
247
|
+
|
|
150
248
|
### Task Lists
|
|
151
249
|
|
|
152
250
|
Create interactive task lists:
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vercel/geistdocs",
|
|
3
3
|
"description": "Runtime and CLI for Geistdocs projects.",
|
|
4
|
-
"version": "1.25.1-canary.
|
|
4
|
+
"version": "1.25.1-canary.eec231d",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
@@ -209,6 +209,7 @@
|
|
|
209
209
|
"mermaid": "^11.12.2",
|
|
210
210
|
"motion": "^12.23.25",
|
|
211
211
|
"next-themes": "^0.4.6",
|
|
212
|
+
"phase": "^0.5.4",
|
|
212
213
|
"radix-ui": "1.6.4",
|
|
213
214
|
"react-player": "^3.4.0",
|
|
214
215
|
"remark-frontmatter": "^5.0.0",
|
|
@@ -3,6 +3,7 @@ import { geistFontClasses } from "@vercel/geistcn/core";
|
|
|
3
3
|
import { cn } from "@vercel/geistcn/utils";
|
|
4
4
|
import "@/lib/geistdocs/site-url-warning";
|
|
5
5
|
import { Footer } from "@vercel/geistdocs/footer";
|
|
6
|
+
import { GeistdocsThemeScript } from "@vercel/geistdocs/layout";
|
|
6
7
|
import { Navbar } from "@vercel/geistdocs/navbar";
|
|
7
8
|
import type { Metadata } from "next";
|
|
8
9
|
import { GeistdocsProvider } from "@/components/geistdocs/provider";
|
|
@@ -30,6 +31,9 @@ const Layout = async ({ children }: LayoutProps<"/[lang]">) => {
|
|
|
30
31
|
lang={lang}
|
|
31
32
|
suppressHydrationWarning
|
|
32
33
|
>
|
|
34
|
+
<head>
|
|
35
|
+
<GeistdocsThemeScript />
|
|
36
|
+
</head>
|
|
33
37
|
<body style={{ backgroundColor: "var(--ds-background-200)" }}>
|
|
34
38
|
<GeistdocsProvider basePath={config.basePath} lang={lang}>
|
|
35
39
|
<Navbar config={config} />
|
|
@@ -5,7 +5,7 @@ import { cva, type VariantProps } from "class-variance-authority"
|
|
|
5
5
|
import { cn } from "@/lib/utils"
|
|
6
6
|
|
|
7
7
|
const buttonVariants = cva(
|
|
8
|
-
"inline-flex items-center justify-center gap-2 whitespace-nowrap rounded-md text-sm font-medium transition-
|
|
8
|
+
"inline-flex items-center justify-center gap-2 whitespace-nowrap rounded-md text-sm font-medium transition-colors disabled:pointer-events-none disabled:opacity-50 [&_svg]:pointer-events-none [&_svg:not([class*='size-'])]:size-4 shrink-0 [&_svg]:shrink-0 outline-none focus-visible:border-gray-600 focus-visible:ring-gray-600/50 focus-visible:ring-[3px] aria-invalid:ring-red-800/20 dark:aria-invalid:ring-red-800/40 aria-invalid:border-red-800",
|
|
9
9
|
{
|
|
10
10
|
variants: {
|
|
11
11
|
variant: {
|
|
@@ -78,8 +78,8 @@ The chat interface adapts to different screen sizes:
|
|
|
78
78
|
|
|
79
79
|
The environment variables `AI_GATEWAY_API_KEY` and `NEXT_PUBLIC_VERCEL_PROJECT_PRODUCTION_URL` must be set, which you can read more about in the [环境变量](/docs/env) section.
|
|
80
80
|
|
|
81
|
-
The model used is `openai/gpt-
|
|
81
|
+
The model used is `openai/gpt-5.6-sol` via the Vercel AI Gateway.
|
|
82
82
|
|
|
83
83
|
## 建议的提示
|
|
84
84
|
|
|
85
|
-
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 [配置](/docs/configuration) section.
|
|
85
|
+
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 [配置](/docs/configuration) section.
|
|
@@ -91,7 +91,7 @@ In this mode, Geistdocs uses the local `search_docs` tool during the AI SDK `str
|
|
|
91
91
|
|
|
92
92
|
#### Choose a model
|
|
93
93
|
|
|
94
|
-
Pass the `model` option to `createChatRoute` to control which model answers Ask AI requests. It accepts any AI SDK `LanguageModel`, including AI Gateway model strings, and defaults to `openai/gpt-
|
|
94
|
+
Pass the `model` option to `createChatRoute` to control which model answers Ask AI requests. It accepts any AI SDK `LanguageModel`, including AI Gateway model strings, and defaults to `openai/gpt-5.6-sol`.
|
|
95
95
|
|
|
96
96
|
```ts title="app/api/chat/route.ts"
|
|
97
97
|
import { createChatRoute } from "@vercel/geistdocs/routes/chat";
|
|
@@ -200,7 +200,7 @@ The chat interface adapts to different screen sizes:
|
|
|
200
200
|
|
|
201
201
|
The environment variables `AI_GATEWAY_API_KEY` and `NEXT_PUBLIC_VERCEL_PROJECT_PRODUCTION_URL` must be set for the default AI Gateway mode. Set `GEISTDOCS_CHAT_PROXY_URL` to route Ask AI through a Vertex-backed proxy instead. You can read more in the [Environment Variables](/docs/env) section.
|
|
202
202
|
|
|
203
|
-
In default AI Gateway mode, Geistdocs uses `openai/gpt-
|
|
203
|
+
In default AI Gateway mode, Geistdocs uses `openai/gpt-5.6-sol` via the Vercel AI Gateway. In Vertex-backed proxy mode, the configured proxy controls the upstream model.
|
|
204
204
|
|
|
205
205
|
## Suggested Prompts
|
|
206
206
|
|
|
@@ -37,7 +37,7 @@ The `.mdx` version returns:
|
|
|
37
37
|
|
|
38
38
|
For a docs section mounted at `/docs`, the section root remains `/docs.md`. For a source mounted at the app root with `baseUrl: "/"`, Geistdocs uses `/index.md` for the root page. If Next.js has `basePath: "/docs"`, that public root Markdown URL is `/docs/index.md`.
|
|
39
39
|
|
|
40
|
-
Copy Page, View as Markdown, and the `text/markdown` metadata alternate all use the same package resolver. Use `createDocsPage({ getMarkdownUrl })` only when the deployment needs a different public contract.
|
|
40
|
+
Copy Page, View as Markdown, and the `text/markdown` metadata alternate all use the same package resolver. View as Markdown opens the resolved `.md` URL in a new tab from a button, which keeps the URL shareable without adding an anchor to the page. Use `createDocsPage({ getMarkdownUrl })` only when the deployment needs a different public contract.
|
|
41
41
|
|
|
42
42
|
## Use cases
|
|
43
43
|
|
|
@@ -67,11 +67,17 @@ Headings automatically generate anchor links for navigation and deep linking.
|
|
|
67
67
|
|
|
68
68
|
Create unordered lists with `-`, `*`, or `+`:
|
|
69
69
|
|
|
70
|
-
|
|
71
|
-
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
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
|
|
75
81
|
|
|
76
82
|
Create ordered lists with numbers:
|
|
77
83
|
|
|
@@ -97,6 +103,84 @@ This renders as:
|
|
|
97
103
|
|
|
98
104
|
<Callout>This is automatically set when deploying to Vercel.</Callout>
|
|
99
105
|
|
|
106
|
+
Callouts can also contain a title and lists:
|
|
107
|
+
|
|
108
|
+
<Callout title="Good to know">
|
|
109
|
+
- The `App Router` uses [React canary
|
|
110
|
+
releases](https://react.dev/blog/2023/05/03/react-canaries) built-in, which
|
|
111
|
+
include all the stable React 19 changes, as well as newer features being
|
|
112
|
+
validated in frameworks, but you should still declare react and react-dom in
|
|
113
|
+
package.json for tooling and ecosystem compatibility.
|
|
114
|
+
- The `Pages Router` uses the React version from your `package.json`.
|
|
115
|
+
</Callout>
|
|
116
|
+
|
|
117
|
+
Callouts support rich inline Markdown, including code, emphasis, and links:
|
|
118
|
+
|
|
119
|
+
```mdx
|
|
120
|
+
<Callout title="Good to know">
|
|
121
|
+
Global styles can be imported into any layout, page, or component inside the
|
|
122
|
+
`app` directory. However, since Next.js uses React's built-in support for
|
|
123
|
+
stylesheets to integrate with Suspense, this currently does not remove
|
|
124
|
+
stylesheets as you navigate between routes which can lead to conflicts. We
|
|
125
|
+
recommend using global styles for _truly global_ CSS (like Tailwind's base
|
|
126
|
+
styles), [Tailwind CSS](https://tailwindcss.com) for component styling, and
|
|
127
|
+
[CSS Modules](https://nextjs.org/docs/app/getting-started/css#css-modules) for
|
|
128
|
+
custom scoped CSS when needed.
|
|
129
|
+
</Callout>
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
This renders as:
|
|
133
|
+
|
|
134
|
+
<Callout title="Good to know">
|
|
135
|
+
Global styles can be imported into any layout, page, or component inside the
|
|
136
|
+
`app` directory. However, since Next.js uses React's built-in support for
|
|
137
|
+
stylesheets to integrate with Suspense, this currently does not remove
|
|
138
|
+
stylesheets as you navigate between routes which can lead to conflicts. We
|
|
139
|
+
recommend using global styles for _truly global_ CSS (like Tailwind's base
|
|
140
|
+
styles), [Tailwind CSS](https://tailwindcss.com) for component styling, and
|
|
141
|
+
[CSS Modules](https://nextjs.org/docs/app/getting-started/css#css-modules) for
|
|
142
|
+
custom scoped CSS when needed.
|
|
143
|
+
</Callout>
|
|
144
|
+
|
|
145
|
+
### Copy Prompts
|
|
146
|
+
|
|
147
|
+
Short prompts render in full without an expansion control:
|
|
148
|
+
|
|
149
|
+
```mdx
|
|
150
|
+
<CopyPrompt text="Summarize this documentation page and list the key concepts.">
|
|
151
|
+
Summarize this documentation page and list the key concepts.
|
|
152
|
+
</CopyPrompt>
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
This renders as:
|
|
156
|
+
|
|
157
|
+
<CopyPrompt text="Summarize this documentation page and list the key concepts.">
|
|
158
|
+
Summarize this documentation page and list the key concepts.
|
|
159
|
+
</CopyPrompt>
|
|
160
|
+
|
|
161
|
+
Long prompts initially show a preview with a **Show more** control:
|
|
162
|
+
|
|
163
|
+
```mdx
|
|
164
|
+
<CopyPrompt collapsible text="Write a detailed migration plan for this project.">
|
|
165
|
+
Write a detailed migration plan for this project. Include prerequisites,
|
|
166
|
+
implementation steps, validation, rollback guidance, and common pitfalls.
|
|
167
|
+
</CopyPrompt>
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
Set the boolean `collapsible` prop when the prompt should initially render as a
|
|
171
|
+
two-line preview. This renders as:
|
|
172
|
+
|
|
173
|
+
<CopyPrompt collapsible text="Review this Geistdocs project in detail. Explain how the @vercel/geistdocs package, application layouts, local adapter files, source configuration, content/docs directory, navigation metadata, MDX components, syntax highlighting, search routes, and deployment configuration work together. Then identify the safest first files to edit, describe the effect of each change, call out common mistakes, and propose a step-by-step plan for customizing the documentation site without breaking routing, generated Markdown, or accessibility behavior.">
|
|
174
|
+
Review this Geistdocs project in detail. Explain how the `@vercel/geistdocs`
|
|
175
|
+
package, application layouts, local adapter files, source configuration,
|
|
176
|
+
`content/docs` directory, navigation metadata, MDX components, syntax
|
|
177
|
+
highlighting, search routes, and deployment configuration work together.
|
|
178
|
+
Then identify the safest first files to edit, describe the effect of each
|
|
179
|
+
change, call out common mistakes, and propose a step-by-step plan for
|
|
180
|
+
customizing the documentation site without breaking routing, generated
|
|
181
|
+
Markdown, or accessibility behavior.
|
|
182
|
+
</CopyPrompt>
|
|
183
|
+
|
|
100
184
|
### Links
|
|
101
185
|
|
|
102
186
|
Create links with `[text](url)`:
|
|
@@ -104,15 +188,25 @@ Create links with `[text](url)`:
|
|
|
104
188
|
- [External link](https://vercel.com)
|
|
105
189
|
- [Internal link](/docs/getting-started)
|
|
106
190
|
|
|
107
|
-
Use an absolute `https://` or `http://` URL
|
|
108
|
-
|
|
109
|
-
|
|
191
|
+
Use an absolute `https://` or `http://` URL for an external destination. Use a
|
|
192
|
+
root-relative path beginning with `/` for an internal link. Both use the same
|
|
193
|
+
visual styling:
|
|
110
194
|
|
|
111
195
|
```md
|
|
112
196
|
[External link](https://vercel.com)
|
|
113
197
|
[Internal link](/docs/getting-started)
|
|
114
198
|
```
|
|
115
199
|
|
|
200
|
+
Links can also contain inline code:
|
|
201
|
+
|
|
202
|
+
```md
|
|
203
|
+
Run independent requests in parallel with [`Promise.all`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise/all).
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
This renders as:
|
|
207
|
+
|
|
208
|
+
Run independent requests in parallel with [`Promise.all`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise/all).
|
|
209
|
+
|
|
116
210
|
### Images
|
|
117
211
|
|
|
118
212
|
Add images with ``:
|
|
@@ -145,6 +239,16 @@ This renders as:
|
|
|
145
239
|
| GFM | GitHub extensions | Supported |
|
|
146
240
|
| MDX | JSX in Markdown | Supported |
|
|
147
241
|
|
|
242
|
+
Tables can also include inline code, as commonly used for file references:
|
|
243
|
+
|
|
244
|
+
| File | Description |
|
|
245
|
+
| -------------------- | ------------------------------------------------ |
|
|
246
|
+
| `next.config.js` | Configuration file for Next.js |
|
|
247
|
+
| `package.json` | Project dependencies and scripts |
|
|
248
|
+
| `instrumentation.ts` | OpenTelemetry and instrumentation file |
|
|
249
|
+
| `.env.local` | Local environment variables |
|
|
250
|
+
| `tsconfig.json` | Configuration file for TypeScript |
|
|
251
|
+
|
|
148
252
|
### Task Lists
|
|
149
253
|
|
|
150
254
|
Create interactive task lists:
|
package/template/package.json
CHANGED
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
"@vercel/analytics": "^1.6.1",
|
|
20
20
|
"@vercel/geistcn": "1.0.3",
|
|
21
21
|
"@vercel/geistcn-assets": "2.0.1",
|
|
22
|
-
"@vercel/geistdocs": "1.25.1-canary.
|
|
22
|
+
"@vercel/geistdocs": "1.25.1-canary.eec231d",
|
|
23
23
|
"@vercel/speed-insights": "^1.3.1",
|
|
24
24
|
"ai": "^6.0.132",
|
|
25
25
|
"class-variance-authority": "^0.7.1",
|