@vercel/geistdocs 1.25.1-canary.4e75e60 → 1.25.1-canary.6261418
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/code-block-tabs.js +1 -1
- package/dist/components/code-block.d.ts.map +1 -1
- package/dist/components/code-block.js +1 -1
- package/dist/components/copy-prompt.js +1 -1
- package/dist/internal/chat/activity.d.ts +20 -0
- package/dist/internal/chat/activity.d.ts.map +1 -0
- package/dist/internal/chat/activity.js +43 -0
- package/dist/internal/chat/message-metadata.d.ts.map +1 -1
- package/dist/internal/chat/message-metadata.js +15 -30
- package/dist/internal/chat/message-sources.d.ts +3 -0
- package/dist/internal/chat/message-sources.d.ts.map +1 -0
- package/dist/internal/chat/message-sources.js +23 -0
- package/dist/internal/chat/message.d.ts.map +1 -1
- package/dist/internal/chat/message.js +35 -3
- package/dist/internal/chat/shell.d.ts.map +1 -1
- package/dist/internal/chat/shell.js +7 -2
- package/dist/internal/chat/source-chunks.d.ts +9 -0
- package/dist/internal/chat/source-chunks.d.ts.map +1 -0
- package/dist/internal/chat/source-chunks.js +7 -0
- package/dist/internal/search.js +1 -1
- package/dist/internal/sidebar-tree.d.ts.map +1 -1
- package/dist/internal/sidebar-tree.js +6 -1
- package/dist/routes/chat.d.ts.map +1 -1
- package/dist/routes/chat.js +30 -13
- package/dist/versions.js +2 -2
- package/docs/agents.md +4 -3
- package/docs/llms.txt +188 -23
- package/docs/manifest.json +12 -3
- package/docs/pages/deployment.md +30 -5
- package/docs/pages/getting-started.md +38 -12
- package/docs/pages/guides/nested-navigation.md +1 -1
- package/docs/pages/migration-2.md +106 -0
- package/docs/pages/migration.md +5 -2
- package/docs/sitemap.md +3 -2
- package/package.json +3 -4
- package/template/content/docs/deployment.mdx +31 -6
- package/template/content/docs/getting-started.mdx +39 -13
- package/template/content/docs/guides/nested-navigation.mdx +1 -1
- package/template/content/docs/meta.json +1 -0
- package/template/content/docs/migration-2.mdx +106 -0
- package/template/content/docs/migration.mdx +5 -1
- package/template/package.json +3 -3
- package/theme.css +0 -4
package/docs/agents.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Geistdocs Package Docs
|
|
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.6261418 so agents can understand the installed package without web access.
|
|
4
4
|
They are generated from `apps/template/content/docs` during the package build.
|
|
5
5
|
|
|
6
6
|
## How to use these files
|
|
@@ -25,8 +25,9 @@ They are generated from `apps/template/content/docs` during the package build.
|
|
|
25
25
|
- [Overview](pages/index.md): Geistdocs is a packaged documentation system for creating Next.js and Fumadocs sites with shared runtime features.
|
|
26
26
|
- [Getting Started](pages/getting-started.md): Create a Geistdocs project, run it locally, and edit your first documentation page.
|
|
27
27
|
- [Environment Variables](pages/env.md): Environment variables required by Geistdocs for AI chat, proxy mode, and production URL configuration.
|
|
28
|
-
- [Deploy to Vercel](pages/deployment.md): Deploy
|
|
29
|
-
- [
|
|
28
|
+
- [Deploy to Vercel](pages/deployment.md): Deploy a Geistdocs site to Vercel with the required project settings, environment variables, and private-package access.
|
|
29
|
+
- [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.
|
|
30
|
+
- [Migrate from Geistdocs 1.x to 2.0](pages/migration-2.md): A concise, agent-friendly checklist for upgrading an existing Geistdocs 1.x site to 2.0.
|
|
30
31
|
- [Configuration](pages/configuration.md): Configure site metadata, navigation, AI features, page actions, translations, and local adapters.
|
|
31
32
|
- [Syntax](pages/syntax.md): Supported MDX syntax including text formatting, code blocks, line highlighting, and Mermaid diagrams.
|
|
32
33
|
- [Geistdocs Provider](pages/provider.md): The root provider component that wraps your application to handle toast notifications, search, and analytics.
|
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.6261418.
|
|
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
|
|
@@ -8,8 +8,9 @@ They describe how to build package-backed Geistdocs sites and how to use the pac
|
|
|
8
8
|
- [Overview](pages/index.md): Geistdocs is a packaged documentation system for creating Next.js and Fumadocs sites with shared runtime features.
|
|
9
9
|
- [Getting Started](pages/getting-started.md): Create a Geistdocs project, run it locally, and edit your first documentation page.
|
|
10
10
|
- [Environment Variables](pages/env.md): Environment variables required by Geistdocs for AI chat, proxy mode, and production URL configuration.
|
|
11
|
-
- [Deploy to Vercel](pages/deployment.md): Deploy
|
|
12
|
-
- [
|
|
11
|
+
- [Deploy to Vercel](pages/deployment.md): Deploy a Geistdocs site to Vercel with the required project settings, environment variables, and private-package access.
|
|
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
|
+
- [Migrate from Geistdocs 1.x to 2.0](pages/migration-2.md): A concise, agent-friendly checklist for upgrading an existing Geistdocs 1.x site to 2.0.
|
|
13
14
|
- [Configuration](pages/configuration.md): Configure site metadata, navigation, AI features, page actions, translations, and local adapters.
|
|
14
15
|
- [Syntax](pages/syntax.md): Supported MDX syntax including text formatting, code blocks, line highlighting, and Mermaid diagrams.
|
|
15
16
|
- [Geistdocs Provider](pages/provider.md): The root provider component that wraps your application to handle toast notifications, search, and analytics.
|
|
@@ -148,39 +149,47 @@ related:
|
|
|
148
149
|
|
|
149
150
|
# Getting Started
|
|
150
151
|
|
|
151
|
-
Create a Geistdocs site with the package CLI, then
|
|
152
|
+
Create a new Geistdocs 2.0 site with the package CLI, then customize its identity, content, and navigation. If you already have a documentation site, use [Migrate to Geistdocs](/docs/migration) or [Migrate 1.x → 2.0](/docs/migration-2) instead.
|
|
152
153
|
|
|
153
|
-
Create a Geistdocs project with `pnpm dlx @vercel/geistdocs init --name my-docs`.
|
|
154
|
+
Create a new Geistdocs project with `pnpm dlx @vercel/geistdocs@latest init --name my-docs`. Confirm the prerequisites, run `pnpm dev`, and help me customize `geistdocs.tsx`, `content/docs/index.mdx`, and `content/docs/meta.json`. Keep the generated integrations package-backed.
|
|
154
155
|
|
|
155
156
|
## Prerequisites
|
|
156
157
|
|
|
157
158
|
Before you begin, install:
|
|
158
159
|
|
|
159
|
-
- Node.js
|
|
160
|
-
- pnpm
|
|
160
|
+
- Node.js 20.9 or later
|
|
161
|
+
- pnpm
|
|
161
162
|
- Git
|
|
162
163
|
|
|
163
|
-
|
|
164
|
+
The CLI always uses pnpm to install the generated project's dependencies.
|
|
164
165
|
|
|
165
|
-
|
|
166
|
+
## Authenticate package access
|
|
166
167
|
|
|
167
|
-
|
|
168
|
-
|
|
168
|
+
Geistdocs 2.0 depends on restricted `@vercel/geistcn` and `@vercel/geistcn-assets` packages. Configure your user-level `~/.npmrc` before running the CLI:
|
|
169
|
+
|
|
170
|
+
```ini title="~/.npmrc"
|
|
171
|
+
@vercel:registry=https://registry.npmjs.org/
|
|
172
|
+
//registry.npmjs.org/:_authToken=${NPM_TOKEN}
|
|
173
|
+
always-auth=true
|
|
169
174
|
```
|
|
170
175
|
|
|
171
|
-
|
|
176
|
+
Set `NPM_TOKEN` from an approved internal source. Never put the token value in `.npmrc`, an `.env` file, shell history, or Git. See [Deploy to Vercel](/docs/deployment#configure-private-package-access) for automated installs.
|
|
177
|
+
|
|
178
|
+
## Create a project
|
|
179
|
+
|
|
180
|
+
Run the Geistdocs CLI from an empty parent folder:
|
|
172
181
|
|
|
173
182
|
```bash title="Terminal"
|
|
174
|
-
|
|
183
|
+
pnpm dlx @vercel/geistdocs@latest init --name my-docs
|
|
175
184
|
```
|
|
176
185
|
|
|
177
186
|
The CLI copies the template bundled in the package, rewrites the generated app to depend on the same `@vercel/geistdocs` version, installs dependencies, copies `.env.example` to `.env.local`, and initializes Git.
|
|
178
187
|
|
|
179
188
|
## Understand generated dependencies
|
|
180
189
|
|
|
181
|
-
Generated projects
|
|
190
|
+
Generated projects pin the resolved `@vercel/geistdocs` version and include its matching Geistcn dependencies, AI SDK v6, and `@ai-sdk/react` v3. The template already configures styles, fonts, Cache Components, Partial Prefetching, source adapters, search, Ask AI, and agent-readable routes.
|
|
182
191
|
|
|
183
|
-
|
|
192
|
+
Keep those integrations package-backed. Update Geistdocs instead of copying package internals into the app.
|
|
184
193
|
|
|
185
194
|
## Start the development server
|
|
186
195
|
|
|
@@ -193,6 +202,14 @@ pnpm dev
|
|
|
193
202
|
|
|
194
203
|
Open `http://localhost:3000` in your browser.
|
|
195
204
|
|
|
205
|
+
Start with these files:
|
|
206
|
+
|
|
207
|
+
- `geistdocs.tsx` for the site title, logo, navigation, repository, and AI prompt.
|
|
208
|
+
- `content/docs/index.mdx` for the documentation overview.
|
|
209
|
+
- `content/docs/meta.json` for sidebar order and groups.
|
|
210
|
+
|
|
211
|
+
Only customize `components/geistdocs/*`, `lib/geistdocs/*`, or route adapters when the generated defaults do not fit your site.
|
|
212
|
+
|
|
196
213
|
## Edit your first page
|
|
197
214
|
|
|
198
215
|
Docs live in `content/docs`. Edit the overview page:
|
|
@@ -251,6 +268,16 @@ pnpm exec geistdocs update
|
|
|
251
268
|
|
|
252
269
|
Review and test dependency changes before committing.
|
|
253
270
|
|
|
271
|
+
## Verify and deploy
|
|
272
|
+
|
|
273
|
+
Run a production build before publishing:
|
|
274
|
+
|
|
275
|
+
```bash title="Terminal"
|
|
276
|
+
pnpm build
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
Then follow [Deploy to Vercel](/docs/deployment), including private package access and environment-variable setup.
|
|
280
|
+
|
|
254
281
|
|
|
255
282
|
---
|
|
256
283
|
|
|
@@ -324,7 +351,7 @@ Set this variable explicitly when deploying outside Vercel. Use a hostname such
|
|
|
324
351
|
title: Deploy to Vercel
|
|
325
352
|
description: Learn how to deploy your Geistdocs site to Vercel
|
|
326
353
|
type: guide
|
|
327
|
-
summary: Deploy
|
|
354
|
+
summary: Deploy a Geistdocs site to Vercel with the required project settings, environment variables, and private-package access.
|
|
328
355
|
url: /docs/deployment
|
|
329
356
|
source: apps/template/content/docs/deployment.mdx
|
|
330
357
|
prerequisites:
|
|
@@ -336,9 +363,9 @@ related:
|
|
|
336
363
|
|
|
337
364
|
# Deploy to Vercel
|
|
338
365
|
|
|
339
|
-
Deploy a Geistdocs site to Vercel as a Next.js app.
|
|
366
|
+
Deploy a Geistdocs site to Vercel as a Next.js app. Configure private package access, environment variables, and the production URL before shipping.
|
|
340
367
|
|
|
341
|
-
Help me deploy this Geistdocs project to Vercel.
|
|
368
|
+
Help me deploy this Geistdocs 2.0 project to Vercel. Verify private npm access for its Geistcn dependencies, then review the package scripts, environment variables, GitHub Actions authentication, and Vercel project settings.
|
|
342
369
|
|
|
343
370
|
## Prerequisites
|
|
344
371
|
|
|
@@ -348,6 +375,31 @@ Before deploying, you need:
|
|
|
348
375
|
- A [Vercel account](https://vercel.com) (sign up at [vercel.com](https://vercel.com))
|
|
349
376
|
- Your Vercel account connected to your GitHub account
|
|
350
377
|
- Environment variables ready (see [Environment Variables](/docs/env))
|
|
378
|
+
- Access to the restricted `@vercel` npm packages
|
|
379
|
+
|
|
380
|
+
## Configure private package access
|
|
381
|
+
|
|
382
|
+
Geistdocs 2.0 depends on restricted `@vercel/geistcn` and `@vercel/geistcn-assets` packages. Package installation fails without npm authentication.
|
|
383
|
+
|
|
384
|
+
For a Vercel deployment, ask `#help-core-platform` to add your Vercel project to the shared `NPM_TOKEN` environment variable list. Include the project link and required environments. Do not copy the shared token into the repository or project documentation.
|
|
385
|
+
|
|
386
|
+
For GitHub Actions, ask `#help-it` to allow the repository to use the `NPM_TOKEN` organization secret, then pass it to the install step:
|
|
387
|
+
|
|
388
|
+
```yaml title=".github/workflows/check.yml"
|
|
389
|
+
- uses: pnpm/action-setup@v4
|
|
390
|
+
|
|
391
|
+
- uses: actions/setup-node@v4
|
|
392
|
+
with:
|
|
393
|
+
node-version: 20
|
|
394
|
+
cache: pnpm
|
|
395
|
+
registry-url: https://registry.npmjs.org
|
|
396
|
+
|
|
397
|
+
- run: pnpm install
|
|
398
|
+
env:
|
|
399
|
+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
|
400
|
+
```
|
|
401
|
+
|
|
402
|
+
Read [How do I use private dependencies with Vercel?](https://vercel.com/kb/guide/using-private-dependencies-with-vercel) for the platform authentication behavior.
|
|
351
403
|
|
|
352
404
|
## Deploy to Vercel
|
|
353
405
|
|
|
@@ -357,9 +409,9 @@ To deploy from the Vercel dashboard:
|
|
|
357
409
|
2. Select your Geistdocs repository
|
|
358
410
|
3. Configure your project settings:
|
|
359
411
|
- **Framework Preset**: Next.js (automatically detected)
|
|
360
|
-
- **Build Command**: `pnpm build`
|
|
412
|
+
- **Build Command**: `pnpm build`
|
|
361
413
|
- **Output Directory**: `.next` (default)
|
|
362
|
-
- **Install Command**: `pnpm install`
|
|
414
|
+
- **Install Command**: `pnpm install`
|
|
363
415
|
4. Add your environment variables (see [Environment Variables](/docs/env))
|
|
364
416
|
5. Click "Deploy"
|
|
365
417
|
|
|
@@ -378,7 +430,7 @@ The Geistdocs site does not need Vertex credentials. The platform proxy authenti
|
|
|
378
430
|
---
|
|
379
431
|
|
|
380
432
|
---
|
|
381
|
-
title:
|
|
433
|
+
title: Migrate to Geistdocs
|
|
382
434
|
description: Migrate a Fumadocs or custom Geist docs site to package-backed Geistdocs
|
|
383
435
|
type: guide
|
|
384
436
|
summary: Move an existing documentation site to @vercel/geistdocs while keeping local content, routing, middleware behavior, and AI-readable surfaces intact.
|
|
@@ -393,10 +445,13 @@ related:
|
|
|
393
445
|
- /docs/agent-readiness
|
|
394
446
|
---
|
|
395
447
|
|
|
396
|
-
#
|
|
448
|
+
# Migrate to Geistdocs
|
|
397
449
|
|
|
398
450
|
Migrate an existing Fumadocs or custom Geist documentation site to `@vercel/geistdocs` by moving shared behavior into package APIs and keeping site-specific adapters local. The safest migration keeps content, routing decisions, and product-specific UI in your app while replacing copied runtime code with thin package-backed adapters.
|
|
399
451
|
|
|
452
|
+
> Note:
|
|
453
|
+
Follow the concise [1.x → 2.0 guide](/docs/migration-2) instead. This page is for adopting Geistdocs from Fumadocs or a custom documentation site.
|
|
454
|
+
|
|
400
455
|
Help me migrate this existing docs site to package-backed Geistdocs. Inspect `source.config.ts`, `lib/geistdocs/source.ts`, app route files, `proxy.ts` or `middleware.ts`, `public/llms.txt`, Open Graph routes, Tailwind CSS setup, `package.json` AI SDK dependencies, and environment variables. Then produce a step-by-step migration plan using `@vercel/geistdocs` package APIs without copying package internals.
|
|
401
456
|
|
|
402
457
|
## Before you migrate
|
|
@@ -804,6 +859,116 @@ Check these URLs locally:
|
|
|
804
859
|
- Read [Agent readiness](/docs/agent-readiness) to configure `/agents.md` and `/.well-known/mcp.json` for AI agents.
|
|
805
860
|
|
|
806
861
|
|
|
862
|
+
---
|
|
863
|
+
|
|
864
|
+
---
|
|
865
|
+
title: Migrate from Geistdocs 1.x to 2.0
|
|
866
|
+
description: Upgrade imports, dependencies, and routing without copying Geistdocs internals
|
|
867
|
+
type: guide
|
|
868
|
+
summary: A concise, agent-friendly checklist for upgrading an existing Geistdocs 1.x site to 2.0.
|
|
869
|
+
url: /docs/migration-2
|
|
870
|
+
source: apps/template/content/docs/migration-2.mdx
|
|
871
|
+
related:
|
|
872
|
+
- /docs/migration
|
|
873
|
+
- /docs/configuration
|
|
874
|
+
- /docs/versioned-docs
|
|
875
|
+
- /docs/proxy
|
|
876
|
+
---
|
|
877
|
+
|
|
878
|
+
# Migrate from Geistdocs 1.x to 2.0
|
|
879
|
+
|
|
880
|
+
Use this guide only for a site already running Geistdocs 1.x. Geistdocs 2.0 moves shared UI primitives and assets to Geistcn; its package-backed page, source, search, chat, proxy, and agent-readable route APIs remain the preferred integration.
|
|
881
|
+
|
|
882
|
+
Upgrade this Geistdocs site from 1.x to 2.0. Inspect `package.json`, `next.config.ts`, `source.config.ts`, the root layout, `lib/geistdocs`, `proxy.ts`, and all imports from `@vercel/geistdocs/components` or `@vercel/geistdocs/assets`. Upgrade the dependencies, replace removed generic component imports with Geistcn, keep Geistdocs-specific components and route adapters package-backed, and verify every public surface. Do not copy package internals into the app.
|
|
883
|
+
|
|
884
|
+
## 1. Upgrade dependencies
|
|
885
|
+
|
|
886
|
+
```bash title="Terminal"
|
|
887
|
+
pnpm add --save-exact @vercel/geistdocs@2 @vercel/geistcn@1.0.3 @vercel/geistcn-assets@2.0.1 next@16.3.3 react@19.2.3 react-dom@19.2.3
|
|
888
|
+
```
|
|
889
|
+
|
|
890
|
+
Geistdocs requires Node.js 20.9 or later. If the app directly uses Ask AI dependencies, use AI SDK v6 and `@ai-sdk/react` v3. Migrate unrelated AI features separately instead of forking Geistdocs chat code.
|
|
891
|
+
|
|
892
|
+
## 2. Replace removed imports
|
|
893
|
+
|
|
894
|
+
| Geistdocs 1.x import | Geistdocs 2.0 replacement |
|
|
895
|
+
| --- | --- |
|
|
896
|
+
| `badge`, `button`, `dialog`, `drawer`, `input`, `kbd`, `separator`, `sheet`, `spinner`, `textarea`, `theme-switcher`, or `tooltip` | Import the matching component from `@vercel/geistcn/components/<name>`. |
|
|
897
|
+
| `switch` | Use `@vercel/geistcn/components/toggle`. |
|
|
898
|
+
| `sonner` | Use `Toasts` and `useToasts` from `@vercel/geistcn/components/toasts`. |
|
|
899
|
+
| `theme-aware-image` | Use Geistcn `Image` with `srcLight` and `srcDark`. |
|
|
900
|
+
| `button-group`, `card`, or `input-group` | Choose a Geistcn component or keep an app-owned composition; there is no API-compatible replacement. |
|
|
901
|
+
| `@vercel/geistdocs/assets/icons` or `assets/icons/*` | `@vercel/geistcn-assets/icons` or `icons/*` |
|
|
902
|
+
| `@vercel/geistdocs/assets/logos` or `assets/logos/*` | `@vercel/geistcn-assets/logos` or `logos/*` |
|
|
903
|
+
|
|
904
|
+
Keep documentation-specific imports such as `callout`, `code-block`, `code-block-tabs`, `collapsible`, `command-prompt`, `copy-prompt`, `mermaid`, and `video` on `@vercel/geistdocs/components/*`.
|
|
905
|
+
|
|
906
|
+
Import the package stylesheet once and apply the Geist font classes at the root:
|
|
907
|
+
|
|
908
|
+
```tsx title="app/[lang]/layout.tsx"
|
|
909
|
+
import "@vercel/geistdocs/styles.css";
|
|
910
|
+
import { geistFontClasses } from "@vercel/geistcn/core";
|
|
911
|
+
|
|
912
|
+
export default function RootLayout({ children }: LayoutProps<"/[lang]">) {
|
|
913
|
+
return (
|
|
914
|
+
<html className={geistFontClasses}>
|
|
915
|
+
<body>{children}</body>
|
|
916
|
+
</html>
|
|
917
|
+
);
|
|
918
|
+
}
|
|
919
|
+
```
|
|
920
|
+
|
|
921
|
+
## 3. Use the Next.js and source integrations
|
|
922
|
+
|
|
923
|
+
```ts title="next.config.ts"
|
|
924
|
+
import { createGeistdocs } from "@vercel/geistdocs/next";
|
|
925
|
+
import type { NextConfig } from "next";
|
|
926
|
+
|
|
927
|
+
const config: NextConfig = {
|
|
928
|
+
modularizeImports: {
|
|
929
|
+
"@vercel/geistcn/components": {
|
|
930
|
+
skipDefaultConversion: true,
|
|
931
|
+
transform: "@vercel/geistcn/components/{{ kebabCase member }}",
|
|
932
|
+
},
|
|
933
|
+
"@vercel/geistcn/core": {
|
|
934
|
+
skipDefaultConversion: true,
|
|
935
|
+
transform: "@vercel/geistcn/core",
|
|
936
|
+
},
|
|
937
|
+
},
|
|
938
|
+
transpilePackages: [
|
|
939
|
+
"@vercel/geistcn",
|
|
940
|
+
"@vercel/geist-test-utils",
|
|
941
|
+
"@vercel/next-themes",
|
|
942
|
+
],
|
|
943
|
+
cacheComponents: true,
|
|
944
|
+
partialPrefetching: true,
|
|
945
|
+
};
|
|
946
|
+
|
|
947
|
+
export default createGeistdocs()(config);
|
|
948
|
+
```
|
|
949
|
+
|
|
950
|
+
In `source.config.ts`, import `defineGeistdocsSourceConfig`, `geistdocsFrontmatterSchema`, and `geistdocsMetaSchema` only from `@vercel/geistdocs/source-config`. Keep pages and route handlers as thin adapters around Geistdocs package APIs.
|
|
951
|
+
|
|
952
|
+
## 4. Preserve routing invariants
|
|
953
|
+
|
|
954
|
+
- If Next.js uses `basePath`, set the same value in Geistdocs config.
|
|
955
|
+
- Keep `content.route`, source `baseUrl`, navigation hrefs, `getPageUrl`, search results, and proxy `markdownRoutes` app-local. Next.js adds the mount prefix once; Geistdocs adds it to public metadata, Markdown, discovery links, and citations.
|
|
956
|
+
- For versioned docs, use `createVersionedSources` and pass server-computed `collectVersionSwitchPaths` to the version selector so missing pages fall back to an existing ancestor.
|
|
957
|
+
- Keep version and router dimensions in static route segments when layouts and sidebar state should persist. Build router-specific, prefix-relative path sets separately from version paths.
|
|
958
|
+
- Keep product-specific navigation titles, badges, related links, and content transforms in the app.
|
|
959
|
+
|
|
960
|
+
## 5. Verify the upgrade
|
|
961
|
+
|
|
962
|
+
- Run install, typecheck, tests, and a production build.
|
|
963
|
+
- Open representative HTML pages and their `.md` equivalents, including a not-found path.
|
|
964
|
+
- Test search, Ask AI citations, proxy rewrites, and agent-readable routes.
|
|
965
|
+
- Switch versions from pages that do and do not exist in the target version.
|
|
966
|
+
- Confirm links do not trigger broad post-load prefetching and Ask AI is not eagerly loaded.
|
|
967
|
+
- Recheck LCP, CLS, accessibility, and post-render network and CPU activity.
|
|
968
|
+
|
|
969
|
+
For a first migration from Fumadocs or a custom docs site, follow the [full migration guide](/docs/migration).
|
|
970
|
+
|
|
971
|
+
|
|
807
972
|
---
|
|
808
973
|
|
|
809
974
|
---
|
|
@@ -3121,7 +3286,7 @@ Geistdocs applies a color for each method:
|
|
|
3121
3286
|
| `PUT`, `PATCH` | Amber |
|
|
3122
3287
|
| `DEL`, `DELETE` | Red |
|
|
3123
3288
|
|
|
3124
|
-
Method matching is case-sensitive, so use uppercase labels. `DEL` and `DELETE` render the same red badge, so prefer `DEL` when you want a narrower badge.
|
|
3289
|
+
Method matching is case-sensitive, so use uppercase labels. `DEL` and `DELETE` render the same red badge, so prefer `DEL` when you want a narrower badge. `New` renders as a low-contrast blue badge; other labels, such as `Beta`, use the default neutral badge. Badge colors adapt to light and dark themes automatically.
|
|
3125
3290
|
|
|
3126
3291
|
## Add links to the navigation
|
|
3127
3292
|
|
package/docs/manifest.json
CHANGED
|
@@ -39,7 +39,7 @@
|
|
|
39
39
|
"description": "Learn how to deploy your Geistdocs site to Vercel",
|
|
40
40
|
"path": "pages/deployment.md",
|
|
41
41
|
"source": "apps/template/content/docs/deployment.mdx",
|
|
42
|
-
"summary": "Deploy
|
|
42
|
+
"summary": "Deploy a Geistdocs site to Vercel with the required project settings, environment variables, and private-package access.",
|
|
43
43
|
"title": "Deploy to Vercel",
|
|
44
44
|
"type": "guide",
|
|
45
45
|
"url": "/docs/deployment"
|
|
@@ -49,10 +49,19 @@
|
|
|
49
49
|
"path": "pages/migration.md",
|
|
50
50
|
"source": "apps/template/content/docs/migration.mdx",
|
|
51
51
|
"summary": "Move an existing documentation site to @vercel/geistdocs while keeping local content, routing, middleware behavior, and AI-readable surfaces intact.",
|
|
52
|
-
"title": "
|
|
52
|
+
"title": "Migrate to Geistdocs",
|
|
53
53
|
"type": "guide",
|
|
54
54
|
"url": "/docs/migration"
|
|
55
55
|
},
|
|
56
|
+
{
|
|
57
|
+
"description": "Upgrade imports, dependencies, and routing without copying Geistdocs internals",
|
|
58
|
+
"path": "pages/migration-2.md",
|
|
59
|
+
"source": "apps/template/content/docs/migration-2.mdx",
|
|
60
|
+
"summary": "A concise, agent-friendly checklist for upgrading an existing Geistdocs 1.x site to 2.0.",
|
|
61
|
+
"title": "Migrate from Geistdocs 1.x to 2.0",
|
|
62
|
+
"type": "guide",
|
|
63
|
+
"url": "/docs/migration-2"
|
|
64
|
+
},
|
|
56
65
|
{
|
|
57
66
|
"description": "Configure a Geistdocs site through local adapter files and package APIs",
|
|
58
67
|
"path": "pages/configuration.md",
|
|
@@ -199,5 +208,5 @@
|
|
|
199
208
|
}
|
|
200
209
|
],
|
|
201
210
|
"source": "apps/template/content/docs",
|
|
202
|
-
"version": "1.25.1-canary.
|
|
211
|
+
"version": "1.25.1-canary.6261418"
|
|
203
212
|
}
|
package/docs/pages/deployment.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
title: Deploy to Vercel
|
|
3
3
|
description: Learn how to deploy your Geistdocs site to Vercel
|
|
4
4
|
type: guide
|
|
5
|
-
summary: Deploy
|
|
5
|
+
summary: Deploy a Geistdocs site to Vercel with the required project settings, environment variables, and private-package access.
|
|
6
6
|
url: /docs/deployment
|
|
7
7
|
source: apps/template/content/docs/deployment.mdx
|
|
8
8
|
prerequisites:
|
|
@@ -14,9 +14,9 @@ related:
|
|
|
14
14
|
|
|
15
15
|
# Deploy to Vercel
|
|
16
16
|
|
|
17
|
-
Deploy a Geistdocs site to Vercel as a Next.js app.
|
|
17
|
+
Deploy a Geistdocs site to Vercel as a Next.js app. Configure private package access, environment variables, and the production URL before shipping.
|
|
18
18
|
|
|
19
|
-
Help me deploy this Geistdocs project to Vercel.
|
|
19
|
+
Help me deploy this Geistdocs 2.0 project to Vercel. Verify private npm access for its Geistcn dependencies, then review the package scripts, environment variables, GitHub Actions authentication, and Vercel project settings.
|
|
20
20
|
|
|
21
21
|
## Prerequisites
|
|
22
22
|
|
|
@@ -26,6 +26,31 @@ Before deploying, you need:
|
|
|
26
26
|
- A [Vercel account](https://vercel.com) (sign up at [vercel.com](https://vercel.com))
|
|
27
27
|
- Your Vercel account connected to your GitHub account
|
|
28
28
|
- Environment variables ready (see [Environment Variables](/docs/env))
|
|
29
|
+
- Access to the restricted `@vercel` npm packages
|
|
30
|
+
|
|
31
|
+
## Configure private package access
|
|
32
|
+
|
|
33
|
+
Geistdocs 2.0 depends on restricted `@vercel/geistcn` and `@vercel/geistcn-assets` packages. Package installation fails without npm authentication.
|
|
34
|
+
|
|
35
|
+
For a Vercel deployment, ask `#help-core-platform` to add your Vercel project to the shared `NPM_TOKEN` environment variable list. Include the project link and required environments. Do not copy the shared token into the repository or project documentation.
|
|
36
|
+
|
|
37
|
+
For GitHub Actions, ask `#help-it` to allow the repository to use the `NPM_TOKEN` organization secret, then pass it to the install step:
|
|
38
|
+
|
|
39
|
+
```yaml title=".github/workflows/check.yml"
|
|
40
|
+
- uses: pnpm/action-setup@v4
|
|
41
|
+
|
|
42
|
+
- uses: actions/setup-node@v4
|
|
43
|
+
with:
|
|
44
|
+
node-version: 20
|
|
45
|
+
cache: pnpm
|
|
46
|
+
registry-url: https://registry.npmjs.org
|
|
47
|
+
|
|
48
|
+
- run: pnpm install
|
|
49
|
+
env:
|
|
50
|
+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Read [How do I use private dependencies with Vercel?](https://vercel.com/kb/guide/using-private-dependencies-with-vercel) for the platform authentication behavior.
|
|
29
54
|
|
|
30
55
|
## Deploy to Vercel
|
|
31
56
|
|
|
@@ -35,9 +60,9 @@ To deploy from the Vercel dashboard:
|
|
|
35
60
|
2. Select your Geistdocs repository
|
|
36
61
|
3. Configure your project settings:
|
|
37
62
|
- **Framework Preset**: Next.js (automatically detected)
|
|
38
|
-
- **Build Command**: `pnpm build`
|
|
63
|
+
- **Build Command**: `pnpm build`
|
|
39
64
|
- **Output Directory**: `.next` (default)
|
|
40
|
-
- **Install Command**: `pnpm install`
|
|
65
|
+
- **Install Command**: `pnpm install`
|
|
41
66
|
4. Add your environment variables (see [Environment Variables](/docs/env))
|
|
42
67
|
5. Click "Deploy"
|
|
43
68
|
|
|
@@ -14,39 +14,47 @@ related:
|
|
|
14
14
|
|
|
15
15
|
# Getting Started
|
|
16
16
|
|
|
17
|
-
Create a Geistdocs site with the package CLI, then
|
|
17
|
+
Create a new Geistdocs 2.0 site with the package CLI, then customize its identity, content, and navigation. If you already have a documentation site, use [Migrate to Geistdocs](/docs/migration) or [Migrate 1.x → 2.0](/docs/migration-2) instead.
|
|
18
18
|
|
|
19
|
-
Create a Geistdocs project with `pnpm dlx @vercel/geistdocs init --name my-docs`.
|
|
19
|
+
Create a new Geistdocs project with `pnpm dlx @vercel/geistdocs@latest init --name my-docs`. Confirm the prerequisites, run `pnpm dev`, and help me customize `geistdocs.tsx`, `content/docs/index.mdx`, and `content/docs/meta.json`. Keep the generated integrations package-backed.
|
|
20
20
|
|
|
21
21
|
## Prerequisites
|
|
22
22
|
|
|
23
23
|
Before you begin, install:
|
|
24
24
|
|
|
25
|
-
- Node.js
|
|
26
|
-
- pnpm
|
|
25
|
+
- Node.js 20.9 or later
|
|
26
|
+
- pnpm
|
|
27
27
|
- Git
|
|
28
28
|
|
|
29
|
-
|
|
29
|
+
The CLI always uses pnpm to install the generated project's dependencies.
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
## Authenticate package access
|
|
32
32
|
|
|
33
|
-
|
|
34
|
-
|
|
33
|
+
Geistdocs 2.0 depends on restricted `@vercel/geistcn` and `@vercel/geistcn-assets` packages. Configure your user-level `~/.npmrc` before running the CLI:
|
|
34
|
+
|
|
35
|
+
```ini title="~/.npmrc"
|
|
36
|
+
@vercel:registry=https://registry.npmjs.org/
|
|
37
|
+
//registry.npmjs.org/:_authToken=${NPM_TOKEN}
|
|
38
|
+
always-auth=true
|
|
35
39
|
```
|
|
36
40
|
|
|
37
|
-
|
|
41
|
+
Set `NPM_TOKEN` from an approved internal source. Never put the token value in `.npmrc`, an `.env` file, shell history, or Git. See [Deploy to Vercel](/docs/deployment#configure-private-package-access) for automated installs.
|
|
42
|
+
|
|
43
|
+
## Create a project
|
|
44
|
+
|
|
45
|
+
Run the Geistdocs CLI from an empty parent folder:
|
|
38
46
|
|
|
39
47
|
```bash title="Terminal"
|
|
40
|
-
|
|
48
|
+
pnpm dlx @vercel/geistdocs@latest init --name my-docs
|
|
41
49
|
```
|
|
42
50
|
|
|
43
51
|
The CLI copies the template bundled in the package, rewrites the generated app to depend on the same `@vercel/geistdocs` version, installs dependencies, copies `.env.example` to `.env.local`, and initializes Git.
|
|
44
52
|
|
|
45
53
|
## Understand generated dependencies
|
|
46
54
|
|
|
47
|
-
Generated projects
|
|
55
|
+
Generated projects pin the resolved `@vercel/geistdocs` version and include its matching Geistcn dependencies, AI SDK v6, and `@ai-sdk/react` v3. The template already configures styles, fonts, Cache Components, Partial Prefetching, source adapters, search, Ask AI, and agent-readable routes.
|
|
48
56
|
|
|
49
|
-
|
|
57
|
+
Keep those integrations package-backed. Update Geistdocs instead of copying package internals into the app.
|
|
50
58
|
|
|
51
59
|
## Start the development server
|
|
52
60
|
|
|
@@ -59,6 +67,14 @@ pnpm dev
|
|
|
59
67
|
|
|
60
68
|
Open `http://localhost:3000` in your browser.
|
|
61
69
|
|
|
70
|
+
Start with these files:
|
|
71
|
+
|
|
72
|
+
- `geistdocs.tsx` for the site title, logo, navigation, repository, and AI prompt.
|
|
73
|
+
- `content/docs/index.mdx` for the documentation overview.
|
|
74
|
+
- `content/docs/meta.json` for sidebar order and groups.
|
|
75
|
+
|
|
76
|
+
Only customize `components/geistdocs/*`, `lib/geistdocs/*`, or route adapters when the generated defaults do not fit your site.
|
|
77
|
+
|
|
62
78
|
## Edit your first page
|
|
63
79
|
|
|
64
80
|
Docs live in `content/docs`. Edit the overview page:
|
|
@@ -116,3 +132,13 @@ pnpm exec geistdocs update
|
|
|
116
132
|
```
|
|
117
133
|
|
|
118
134
|
Review and test dependency changes before committing.
|
|
135
|
+
|
|
136
|
+
## Verify and deploy
|
|
137
|
+
|
|
138
|
+
Run a production build before publishing:
|
|
139
|
+
|
|
140
|
+
```bash title="Terminal"
|
|
141
|
+
pnpm build
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
Then follow [Deploy to Vercel](/docs/deployment), including private package access and environment-variable setup.
|
|
@@ -200,7 +200,7 @@ Geistdocs applies a color for each method:
|
|
|
200
200
|
| `PUT`, `PATCH` | Amber |
|
|
201
201
|
| `DEL`, `DELETE` | Red |
|
|
202
202
|
|
|
203
|
-
Method matching is case-sensitive, so use uppercase labels. `DEL` and `DELETE` render the same red badge, so prefer `DEL` when you want a narrower badge.
|
|
203
|
+
Method matching is case-sensitive, so use uppercase labels. `DEL` and `DELETE` render the same red badge, so prefer `DEL` when you want a narrower badge. `New` renders as a low-contrast blue badge; other labels, such as `Beta`, use the default neutral badge. Badge colors adapt to light and dark themes automatically.
|
|
204
204
|
|
|
205
205
|
## Add links to the navigation
|
|
206
206
|
|