@vercel/geistdocs 1.25.1-canary.4e75e60 → 1.25.1-canary.62250e6

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 (86) hide show
  1. package/dist/cli/index.js +1 -1
  2. package/dist/components/code-block-tabs.js +1 -1
  3. package/dist/components/code-block.d.ts.map +1 -1
  4. package/dist/components/code-block.js +1 -1
  5. package/dist/components/copy-prompt.js +1 -1
  6. package/dist/components/image.d.ts +19 -0
  7. package/dist/components/image.d.ts.map +1 -0
  8. package/dist/components/image.js +9 -0
  9. package/dist/components/steps.d.ts +9 -0
  10. package/dist/components/steps.d.ts.map +1 -0
  11. package/dist/components/steps.js +9 -0
  12. package/dist/internal/chat/activity.d.ts +20 -0
  13. package/dist/internal/chat/activity.d.ts.map +1 -0
  14. package/dist/internal/chat/activity.js +43 -0
  15. package/dist/internal/chat/message-metadata.d.ts.map +1 -1
  16. package/dist/internal/chat/message-metadata.js +15 -30
  17. package/dist/internal/chat/message-sources.d.ts +3 -0
  18. package/dist/internal/chat/message-sources.d.ts.map +1 -0
  19. package/dist/internal/chat/message-sources.js +23 -0
  20. package/dist/internal/chat/message.d.ts.map +1 -1
  21. package/dist/internal/chat/message.js +44 -10
  22. package/dist/internal/chat/shell.d.ts.map +1 -1
  23. package/dist/internal/chat/shell.js +7 -2
  24. package/dist/internal/chat/source-chunks.d.ts +9 -0
  25. package/dist/internal/chat/source-chunks.d.ts.map +1 -0
  26. package/dist/internal/chat/source-chunks.js +7 -0
  27. package/dist/internal/chat/sources.d.ts +1 -1
  28. package/dist/internal/chat/sources.d.ts.map +1 -1
  29. package/dist/internal/chat/sources.js +6 -3
  30. package/dist/internal/link-href.d.ts +13 -0
  31. package/dist/internal/link-href.d.ts.map +1 -0
  32. package/dist/internal/link-href.js +51 -0
  33. package/dist/internal/mdx-to-markdown.d.ts +3 -0
  34. package/dist/internal/mdx-to-markdown.d.ts.map +1 -0
  35. package/dist/internal/mdx-to-markdown.js +166 -0
  36. package/dist/internal/react-node-text.d.ts +4 -0
  37. package/dist/internal/react-node-text.d.ts.map +1 -0
  38. package/dist/internal/react-node-text.js +11 -0
  39. package/dist/internal/search.js +1 -1
  40. package/dist/internal/sidebar-tree.d.ts.map +1 -1
  41. package/dist/internal/sidebar-tree.js +6 -1
  42. package/dist/internal/toc-items.d.ts.map +1 -1
  43. package/dist/internal/toc-items.js +2 -1
  44. package/dist/mdx.d.ts.map +1 -1
  45. package/dist/mdx.js +5 -0
  46. package/dist/pages/docs.d.ts.map +1 -1
  47. package/dist/pages/docs.js +10 -5
  48. package/dist/routes/chat.d.ts.map +1 -1
  49. package/dist/routes/chat.js +30 -13
  50. package/dist/routes/llms.d.ts +1 -1
  51. package/dist/routes/llms.d.ts.map +1 -1
  52. package/dist/routes/llms.js +12 -2
  53. package/dist/source-config.d.ts +10 -0
  54. package/dist/source-config.d.ts.map +1 -1
  55. package/dist/source-config.js +20 -2
  56. package/dist/source.d.ts +10 -1
  57. package/dist/source.d.ts.map +1 -1
  58. package/dist/source.js +75 -34
  59. package/dist/versions.js +2 -2
  60. package/docs/agents.md +5 -3
  61. package/docs/llms.txt +388 -28
  62. package/docs/manifest.json +21 -3
  63. package/docs/pages/components/steps.md +129 -0
  64. package/docs/pages/deployment.md +30 -5
  65. package/docs/pages/getting-started.md +38 -12
  66. package/docs/pages/guides/nested-navigation.md +1 -1
  67. package/docs/pages/md.md +24 -5
  68. package/docs/pages/migration-2.md +106 -0
  69. package/docs/pages/migration.md +5 -2
  70. package/docs/pages/syntax.md +42 -0
  71. package/docs/sitemap.md +4 -2
  72. package/package.json +14 -4
  73. package/source-config.js +37 -2
  74. package/template/content/docs/components/meta.json +4 -0
  75. package/template/content/docs/components/steps.mdx +125 -0
  76. package/template/content/docs/deployment.mdx +31 -6
  77. package/template/content/docs/getting-started.mdx +39 -13
  78. package/template/content/docs/guides/nested-navigation.mdx +1 -1
  79. package/template/content/docs/md.mdx +24 -5
  80. package/template/content/docs/meta.json +3 -0
  81. package/template/content/docs/migration-2.mdx +106 -0
  82. package/template/content/docs/migration.mdx +5 -1
  83. package/template/content/docs/syntax.mdx +42 -0
  84. package/template/next.config.ts +9 -0
  85. package/template/package.json +3 -3
  86. package/theme.css +50 -4
package/source-config.js CHANGED
@@ -2,7 +2,12 @@ import { execFile } from "node:child_process";
2
2
  import { readFile } from "node:fs/promises";
3
3
  import path from "node:path";
4
4
  import { promisify } from "node:util";
5
- import { remarkMdxMermaid } from "fumadocs-core/mdx-plugins";
5
+ import {
6
+ remarkHeading,
7
+ remarkMdxMermaid,
8
+ remarkSteps,
9
+ remarkStructure,
10
+ } from "fumadocs-core/mdx-plugins";
6
11
  import {
7
12
  defineConfig as defineFumadocsConfig,
8
13
  frontmatterSchema,
@@ -236,6 +241,35 @@ export const geistdocsFrontmatterSchema = frontmatterSchema.extend({
236
241
 
237
242
  export const geistdocsMetaSchema = metaSchema;
238
243
 
244
+ const pluginOf = (entry) => (Array.isArray(entry) ? entry[0] : entry);
245
+
246
+ const indexOfPlugin = (list, plugin) =>
247
+ list.findIndex((entry) => pluginOf(entry) === plugin);
248
+
249
+ // Mirrors src/source-config.ts. `remarkSteps` must run before `remarkHeading`,
250
+ // otherwise the `1. ` prefix that marks a step heading leaks into the heading
251
+ // slug and table of contents. Geistdocs and consumer plugins keep their
252
+ // previous slot ahead of `remarkStructure` so search indexing sees their output.
253
+ export const resolveGeistdocsRemarkPlugins = (
254
+ defaults,
255
+ consumerPlugins = []
256
+ ) => {
257
+ const list = [...defaults];
258
+
259
+ const headingIndex = indexOfPlugin(list, remarkHeading);
260
+ list.splice(headingIndex === -1 ? 0 : headingIndex, 0, remarkSteps);
261
+
262
+ const structureIndex = indexOfPlugin(list, remarkStructure);
263
+ list.splice(
264
+ structureIndex === -1 ? list.length : structureIndex,
265
+ 0,
266
+ remarkMdxMermaid,
267
+ ...consumerPlugins
268
+ );
269
+
270
+ return list;
271
+ };
272
+
239
273
  export const defineGeistdocsSourceConfig = (config = {}) => {
240
274
  const existingRemarkPlugins = Array.isArray(config.mdxOptions?.remarkPlugins)
241
275
  ? config.mdxOptions.remarkPlugins
@@ -246,7 +280,8 @@ export const defineGeistdocsSourceConfig = (config = {}) => {
246
280
  ...config,
247
281
  mdxOptions: {
248
282
  ...config.mdxOptions,
249
- remarkPlugins: [remarkMdxMermaid, ...existingRemarkPlugins],
283
+ remarkPlugins: (defaults) =>
284
+ resolveGeistdocsRemarkPlugins(defaults, existingRemarkPlugins),
250
285
  rehypeCodeOptions: {
251
286
  ...config.mdxOptions?.rehypeCodeOptions,
252
287
  themes: { light: geistShikiTheme, dark: geistShikiTheme },
@@ -0,0 +1,4 @@
1
+ {
2
+ "title": "Components",
3
+ "pages": ["steps"]
4
+ }
@@ -0,0 +1,125 @@
1
+ ---
2
+ title: Steps
3
+ description: Render numbered step-by-step instructions from Markdown headings or the Steps and Step components
4
+ type: reference
5
+ summary: 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.
6
+ prerequisites:
7
+ - /docs/syntax
8
+ related:
9
+ - /docs/syntax
10
+ - /docs/table-of-contents
11
+ ---
12
+
13
+ Steps render sequential instructions as a numbered list with a counter beside each step heading. You write them as plain Markdown headings, so a page needs no imports and stays readable in Markdown output.
14
+
15
+ ## Write steps as numbered headings
16
+
17
+ Start each step heading with a number, a period, and a space. Consecutive headings at the same depth that follow this pattern become one step list.
18
+
19
+ ````md
20
+ ## Deploy the project
21
+
22
+ ### 1. Install the CLI
23
+
24
+ Install the Vercel CLI globally.
25
+
26
+ ```bash
27
+ pnpm add -g vercel
28
+ ```
29
+
30
+ ### 2. Link the project
31
+
32
+ Run `vercel link` in the project directory and pick the team and project.
33
+
34
+ ### 3. Deploy
35
+
36
+ Run `vercel deploy` to create a preview deployment.
37
+
38
+ ## Next section
39
+ ````
40
+
41
+ This renders as:
42
+
43
+ ### 1. Install the CLI
44
+
45
+ Install the Vercel CLI globally.
46
+
47
+ ```bash
48
+ pnpm add -g vercel
49
+ ```
50
+
51
+ ### 2. Link the project
52
+
53
+ Run `vercel link` in the project directory and pick the team and project.
54
+
55
+ ### 3. Deploy
56
+
57
+ Run `vercel deploy` to create a preview deployment.
58
+
59
+ ## How numbering and anchors work
60
+
61
+ Geistdocs removes the `1. ` prefix from the heading text at build time and draws the number with a CSS counter. As a result:
62
+
63
+ - The table of contents shows `Install the CLI`, not `1. Install the CLI`.
64
+ - The heading anchor is `#install-the-cli`, so renumbering steps does not break links.
65
+ - Custom anchors written as `### 1. Install the CLI [#install]` keep working.
66
+ - Markdown routes and `llms.txt` output numbered headings, such as `### 1. Install the CLI`, which read naturally for agents.
67
+
68
+ The numbers you write are only used to detect steps. Geistdocs always counts from 1, so `### 4. Deploy` at the start of a list renders as step 1.
69
+
70
+ ## Rules for grouping steps
71
+
72
+ Geistdocs groups headings into a step list using these rules:
73
+
74
+ | Situation | Result |
75
+ | --- | --- |
76
+ | Consecutive numbered headings at the same depth | One step list |
77
+ | A deeper heading inside a step, such as `#### Options` under `### 2. Configure` | Part of the current step |
78
+ | A heading at the same or shallower depth without a number prefix | Ends the step list |
79
+ | A numbered heading where inline code or a link immediately follows the number, such as `` ### 1. `vercel login` `` | Not detected as a step; move a word before the code, such as `` ### 1. Run `vercel login` `` |
80
+
81
+ Paragraphs, lists, code blocks, callouts, and images between two step headings belong to the earlier step.
82
+
83
+ ## Use the Steps and Step components
84
+
85
+ Use the components when a step heading has to be wrapped in another component, for example a framework switcher, and the heading pattern cannot be detected. Both components are in the default MDX component map and are exported from `@vercel/geistdocs/components/steps`.
86
+
87
+ ```mdx
88
+ <Steps>
89
+ <Step>
90
+ ### Install the package
91
+
92
+ Run the install command for your package manager.
93
+ </Step>
94
+ <Step>
95
+ ### Configure the project
96
+
97
+ Add the configuration file to the project root.
98
+ </Step>
99
+ </Steps>
100
+ ```
101
+
102
+ This renders as:
103
+
104
+ <Steps>
105
+ <Step>
106
+ ### Install the package
107
+
108
+ Run the install command for your package manager.
109
+ </Step>
110
+ <Step>
111
+ ### Configure the project
112
+
113
+ Add the configuration file to the project root.
114
+ </Step>
115
+ </Steps>
116
+
117
+ Do not add a number prefix to headings inside `Step`. The component draws the counter, and a prefix would create a nested step list.
118
+
119
+ ### Props
120
+
121
+ `Steps` and `Step` accept the standard `div` attributes. Both forward `className`, which is merged with the `fd-steps` and `fd-step` classes that carry the counter styling.
122
+
123
+ ## Markdown output
124
+
125
+ In `.md` routes and `llms.txt`, each step list becomes plain numbered headings, such as `### 1. Install the CLI`, followed by the step content. This applies to steps written as headings and to steps written with `Steps` and `Step`, so agents read the same sequence without the wrapper markup.
@@ -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 your Geistdocs site to Vercel from the dashboard with the correct project settings.
5
+ summary: Deploy a Geistdocs site to Vercel with the required project settings, environment variables, and private-package access.
6
6
  prerequisites:
7
7
  - /docs/getting-started
8
8
  - /docs/env
@@ -10,10 +10,10 @@ related:
10
10
  - /docs/configuration
11
11
  ---
12
12
 
13
- Deploy a Geistdocs site to Vercel as a Next.js app. Make sure your package dependency, environment variables, and production URL are configured before shipping.
13
+ Deploy a Geistdocs site to Vercel as a Next.js app. Configure private package access, environment variables, and the production URL before shipping.
14
14
 
15
- <CopyPrompt text="Help me deploy this Geistdocs project to Vercel. Check the package scripts, required environment variables, and Vercel project settings, then give me a deploy checklist for production.">
16
- Help me deploy this Geistdocs project to Vercel. Check the package scripts, required environment variables, and Vercel project settings, then give me a deploy checklist for production.
15
+ <CopyPrompt text="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.">
16
+ 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.
17
17
  </CopyPrompt>
18
18
 
19
19
  ## Prerequisites
@@ -24,6 +24,31 @@ Before deploying, you need:
24
24
  - A [Vercel account](https://vercel.com) (sign up at [vercel.com](https://vercel.com))
25
25
  - Your Vercel account connected to your GitHub account
26
26
  - Environment variables ready (see [Environment Variables](/docs/env))
27
+ - Access to the restricted `@vercel` npm packages
28
+
29
+ ## Configure private package access
30
+
31
+ Geistdocs 2.0 depends on restricted `@vercel/geistcn` and `@vercel/geistcn-assets` packages. Package installation fails without npm authentication.
32
+
33
+ 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.
34
+
35
+ For GitHub Actions, ask `#help-it` to allow the repository to use the `NPM_TOKEN` organization secret, then pass it to the install step:
36
+
37
+ ```yaml title=".github/workflows/check.yml"
38
+ - uses: pnpm/action-setup@v4
39
+
40
+ - uses: actions/setup-node@v4
41
+ with:
42
+ node-version: 20
43
+ cache: pnpm
44
+ registry-url: https://registry.npmjs.org
45
+
46
+ - run: pnpm install
47
+ env:
48
+ NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
49
+ ```
50
+
51
+ Read [How do I use private dependencies with Vercel?](https://vercel.com/kb/guide/using-private-dependencies-with-vercel) for the platform authentication behavior.
27
52
 
28
53
  ## Deploy to Vercel
29
54
 
@@ -33,9 +58,9 @@ To deploy from the Vercel dashboard:
33
58
  2. Select your Geistdocs repository
34
59
  3. Configure your project settings:
35
60
  - **Framework Preset**: Next.js (automatically detected)
36
- - **Build Command**: `pnpm build` or `npm run build`
61
+ - **Build Command**: `pnpm build`
37
62
  - **Output Directory**: `.next` (default)
38
- - **Install Command**: `pnpm install` or `npm install`
63
+ - **Install Command**: `pnpm install`
39
64
  4. Add your environment variables (see [Environment Variables](/docs/env))
40
65
  5. Click "Deploy"
41
66
 
@@ -10,41 +10,49 @@ related:
10
10
  - /docs/deployment
11
11
  ---
12
12
 
13
- Create a Geistdocs site with the package CLI, then edit the generated content and configuration files. If you already have a Fumadocs or custom Geist docs site, read [Migration guide](/docs/migration) before moving route adapters and middleware behavior.
13
+ 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.
14
14
 
15
- <CopyPrompt text="Create a Geistdocs project with pnpm dlx @vercel/geistdocs init --name my-docs. Then open my-docs, run pnpm dev, and explain which files I should edit first: geistdocs.tsx, content/docs, content/docs/meta.json, and components/geistdocs/mdx-components.tsx.">
16
- Create a Geistdocs project with `pnpm dlx @vercel/geistdocs init --name my-docs`. Then open `my-docs`, run `pnpm dev`, and explain which files I should edit first: `geistdocs.tsx`, `content/docs`, `content/docs/meta.json`, and `components/geistdocs/mdx-components.tsx`.
15
+ <CopyPrompt text="Create a new Geistdocs project with pnpm dlx @vercel/geistdocs@latest init --name my-docs. Confirm Node.js 20.9 or later, pnpm, Git, and npm access to the @vercel scope are available first. Then run pnpm dev and help me customize geistdocs.tsx, content/docs/index.mdx, and content/docs/meta.json. Keep the generated route, source, Geistcn, and Next.js integrations package-backed.">
16
+ 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.
17
17
  </CopyPrompt>
18
18
 
19
19
  ## Prerequisites
20
20
 
21
21
  Before you begin, install:
22
22
 
23
- - Node.js 18 or later
24
- - pnpm, npm, or another package manager
23
+ - Node.js 20.9 or later
24
+ - pnpm
25
25
  - Git
26
26
 
27
- ## Create a project
27
+ The CLI always uses pnpm to install the generated project's dependencies.
28
28
 
29
- Run the Geistdocs CLI from an empty parent folder:
29
+ ## Authenticate package access
30
30
 
31
- ```bash title="Terminal"
32
- pnpm dlx @vercel/geistdocs init --name my-docs
31
+ Geistdocs 2.0 depends on restricted `@vercel/geistcn` and `@vercel/geistcn-assets` packages. Configure your user-level `~/.npmrc` before running the CLI:
32
+
33
+ ```ini title="~/.npmrc"
34
+ @vercel:registry=https://registry.npmjs.org/
35
+ //registry.npmjs.org/:_authToken=${NPM_TOKEN}
36
+ always-auth=true
33
37
  ```
34
38
 
35
- You can also use npm:
39
+ 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.
40
+
41
+ ## Create a project
42
+
43
+ Run the Geistdocs CLI from an empty parent folder:
36
44
 
37
45
  ```bash title="Terminal"
38
- npx @vercel/geistdocs init --name my-docs
46
+ pnpm dlx @vercel/geistdocs@latest init --name my-docs
39
47
  ```
40
48
 
41
49
  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.
42
50
 
43
51
  ## Understand generated dependencies
44
52
 
45
- Generated projects include `@vercel/geistdocs`, `ai` v6, and `@ai-sdk/react` v3. Geistdocs uses those AI SDK packages for Ask AI, including the chat client transport and `createChatRoute` server behavior.
53
+ 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.
46
54
 
47
- Update Ask AI by updating `@vercel/geistdocs`, not by copying package chat internals into the app. If your project uses the AI SDK directly for separate product features, keep that code compatible with the app's installed AI SDK version; package-owned Ask AI does not need to match another consumer project's `ai` version.
55
+ Keep those integrations package-backed. Update Geistdocs instead of copying package internals into the app.
48
56
 
49
57
  ## Start the development server
50
58
 
@@ -57,6 +65,14 @@ pnpm dev
57
65
 
58
66
  Open `http://localhost:3000` in your browser.
59
67
 
68
+ Start with these files:
69
+
70
+ - `geistdocs.tsx` for the site title, logo, navigation, repository, and AI prompt.
71
+ - `content/docs/index.mdx` for the documentation overview.
72
+ - `content/docs/meta.json` for sidebar order and groups.
73
+
74
+ Only customize `components/geistdocs/*`, `lib/geistdocs/*`, or route adapters when the generated defaults do not fit your site.
75
+
60
76
  ## Edit your first page
61
77
 
62
78
  Docs live in `content/docs`. Edit the overview page:
@@ -114,3 +130,13 @@ pnpm exec geistdocs update
114
130
  ```
115
131
 
116
132
  Review and test dependency changes before committing.
133
+
134
+ ## Verify and deploy
135
+
136
+ Run a production build before publishing:
137
+
138
+ ```bash title="Terminal"
139
+ pnpm build
140
+ ```
141
+
142
+ Then follow [Deploy to Vercel](/docs/deployment), including private package access and environment-variable setup.
@@ -197,7 +197,7 @@ Geistdocs applies a color for each method:
197
197
  | `PUT`, `PATCH` | Amber |
198
198
  | `DEL`, `DELETE` | Red |
199
199
 
200
- 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. Any other label, such as `Beta`, keeps the default blue badge. Badge colors adapt to light and dark themes automatically.
200
+ 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.
201
201
 
202
202
  ## Add links to the navigation
203
203
 
@@ -9,7 +9,7 @@ related:
9
9
  - /docs/proxy
10
10
  ---
11
11
 
12
- Geistdocs lets AI tools and language models access documentation pages as plain Markdown. Append `.md` or `.mdx` to a documentation URL to get the processed Markdown content for that page.
12
+ Geistdocs lets AI tools and language models access documentation pages as plain Markdown. Append `.md` or `.mdx` to a documentation URL to get the page content with presentation-only MDX components removed.
13
13
 
14
14
  <CopyPrompt text="Help me test raw Markdown routes in this Geistdocs project. Fetch a docs page with .mdx appended, compare it to the rendered page, and explain how AI tools can use it.">
15
15
  Help me test raw Markdown routes in this Geistdocs project. Fetch a docs page with `.mdx` appended, compare it to the rendered page, and explain how AI tools can use it.
@@ -31,8 +31,8 @@ https://yourdomain.com/docs/getting-started.mdx
31
31
 
32
32
  The `.mdx` version returns:
33
33
 
34
- - The page title as an H1 heading
35
- - The full processed Markdown content
34
+ - Frontmatter with the canonical page URL, docs index, and last-updated date when available
35
+ - The full page content as plain Markdown
36
36
  - No HTML, styling, or navigation
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`.
@@ -81,11 +81,30 @@ The response includes:
81
81
 
82
82
  - Content-Type: `text/markdown`
83
83
  - `Link: <canonical page URL>; rel="canonical"` for resolved pages
84
- - The page title as a level 1 heading
85
- - Processed Markdown content from Fumadocs
84
+ - Frontmatter with page metadata and discovery links
85
+ - Page content with presentation-only MDX components removed
86
86
 
87
87
  All MDX components are processed and converted to plain Markdown equivalents.
88
88
 
89
+ ### Customize frontmatter
90
+
91
+ Geistdocs generates `title`, `description`, `url`, `docs_index`, and `lastUpdated` when their values are available, along with supported page frontmatter such as `prerequisites` and `related`. Add product-specific fields or override defaults with the source `markdown.frontmatter` hook:
92
+
93
+ ```ts title="lib/geistdocs/source.ts"
94
+ export const geistdocsSource = createSource({
95
+ config,
96
+ docs,
97
+ markdown: {
98
+ frontmatter: (defaults) => ({
99
+ docs_index: "/docs/llms.txt",
100
+ version: "16.3.4",
101
+ }),
102
+ },
103
+ });
104
+ ```
105
+
106
+ The callback returns only additions and overrides; Geistdocs keeps the remaining generated fields from `defaults`.
107
+
89
108
  ## Missing documentation pages
90
109
 
91
110
  When a Markdown request does not match a page, Geistdocs returns an agent-readable `Page Not Found` response. It compares the requested path with visible page paths and titles, then links up to five likely matches with their descriptions. If no match is useful, the response links to `/llms.txt` instead.
@@ -9,12 +9,15 @@
9
9
  "env",
10
10
  "deployment",
11
11
  "migration",
12
+ "migration-2",
12
13
  "configuration",
13
14
  "---Internals---",
14
15
  "syntax",
15
16
  "provider",
16
17
  "versioned-docs",
17
18
  "proxy",
19
+ "---Components---",
20
+ "components",
18
21
  "---Features---",
19
22
  "...",
20
23
  "---AI---",
@@ -0,0 +1,106 @@
1
+ ---
2
+ title: Migrate from Geistdocs 1.x to 2.0
3
+ navTitle: Migrate 1.x → 2.0
4
+ badge: New
5
+ description: Upgrade imports, dependencies, and routing without copying Geistdocs internals
6
+ type: guide
7
+ summary: A concise, agent-friendly checklist for upgrading an existing Geistdocs 1.x site to 2.0.
8
+ related:
9
+ - /docs/migration
10
+ - /docs/configuration
11
+ - /docs/versioned-docs
12
+ - /docs/proxy
13
+ ---
14
+
15
+ 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.
16
+
17
+ <CopyPrompt text="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 @vercel/geistcn/components/*, replace icon and logo imports with @vercel/geistcn-assets, keep Geistdocs-specific components and all route adapters package-backed, enable cacheComponents and partialPrefetching, apply geistFontClasses once, and preserve app-local paths when basePath is configured. If the site has versions, use createVersionedSources and pass collectVersionSwitchPaths to the version selector. Run install, typecheck, and build, then verify HTML, Markdown, search, Ask AI, and version fallbacks. Do not copy package internals into the app.">
18
+ 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.
19
+ </CopyPrompt>
20
+
21
+ ## 1. Upgrade dependencies
22
+
23
+ ```bash title="Terminal"
24
+ 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
25
+ ```
26
+
27
+ 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.
28
+
29
+ ## 2. Replace removed imports
30
+
31
+ | Geistdocs 1.x import | Geistdocs 2.0 replacement |
32
+ | --- | --- |
33
+ | `badge`, `button`, `dialog`, `drawer`, `input`, `kbd`, `separator`, `sheet`, `spinner`, `textarea`, `theme-switcher`, or `tooltip` | Import the matching component from `@vercel/geistcn/components/<name>`. |
34
+ | `switch` | Use `@vercel/geistcn/components/toggle`. |
35
+ | `sonner` | Use `Toasts` and `useToasts` from `@vercel/geistcn/components/toasts`. |
36
+ | `theme-aware-image` | Use Geistcn `Image` with `srcLight` and `srcDark`. |
37
+ | `button-group`, `card`, or `input-group` | Choose a Geistcn component or keep an app-owned composition; there is no API-compatible replacement. |
38
+ | `@vercel/geistdocs/assets/icons` or `assets/icons/*` | `@vercel/geistcn-assets/icons` or `icons/*` |
39
+ | `@vercel/geistdocs/assets/logos` or `assets/logos/*` | `@vercel/geistcn-assets/logos` or `logos/*` |
40
+
41
+ Keep documentation-specific imports such as `callout`, `code-block`, `code-block-tabs`, `collapsible`, `command-prompt`, `copy-prompt`, `mermaid`, and `video` on `@vercel/geistdocs/components/*`.
42
+
43
+ Import the package stylesheet once and apply the Geist font classes at the root:
44
+
45
+ ```tsx title="app/[lang]/layout.tsx"
46
+ import "@vercel/geistdocs/styles.css";
47
+ import { geistFontClasses } from "@vercel/geistcn/core";
48
+
49
+ export default function RootLayout({ children }: LayoutProps<"/[lang]">) {
50
+ return (
51
+ <html className={geistFontClasses}>
52
+ <body>{children}</body>
53
+ </html>
54
+ );
55
+ }
56
+ ```
57
+
58
+ ## 3. Use the Next.js and source integrations
59
+
60
+ ```ts title="next.config.ts"
61
+ import { createGeistdocs } from "@vercel/geistdocs/next";
62
+ import type { NextConfig } from "next";
63
+
64
+ const config: NextConfig = {
65
+ modularizeImports: {
66
+ "@vercel/geistcn/components": {
67
+ skipDefaultConversion: true,
68
+ transform: "@vercel/geistcn/components/{{ kebabCase member }}",
69
+ },
70
+ "@vercel/geistcn/core": {
71
+ skipDefaultConversion: true,
72
+ transform: "@vercel/geistcn/core",
73
+ },
74
+ },
75
+ transpilePackages: [
76
+ "@vercel/geistcn",
77
+ "@vercel/geist-test-utils",
78
+ "@vercel/next-themes",
79
+ ],
80
+ cacheComponents: true,
81
+ partialPrefetching: true,
82
+ };
83
+
84
+ export default createGeistdocs()(config);
85
+ ```
86
+
87
+ 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.
88
+
89
+ ## 4. Preserve routing invariants
90
+
91
+ - If Next.js uses `basePath`, set the same value in Geistdocs config.
92
+ - 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.
93
+ - For versioned docs, use `createVersionedSources` and pass server-computed `collectVersionSwitchPaths` to the version selector so missing pages fall back to an existing ancestor.
94
+ - 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.
95
+ - Keep product-specific navigation titles, badges, related links, and content transforms in the app.
96
+
97
+ ## 5. Verify the upgrade
98
+
99
+ - Run install, typecheck, tests, and a production build.
100
+ - Open representative HTML pages and their `.md` equivalents, including a not-found path.
101
+ - Test search, Ask AI citations, proxy rewrites, and agent-readable routes.
102
+ - Switch versions from pages that do and do not exist in the target version.
103
+ - Confirm links do not trigger broad post-load prefetching and Ask AI is not eagerly loaded.
104
+ - Recheck LCP, CLS, accessibility, and post-render network and CPU activity.
105
+
106
+ For a first migration from Fumadocs or a custom docs site, follow the [full migration guide](/docs/migration).
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: Migration guide
2
+ title: Migrate to Geistdocs
3
3
  description: Migrate a Fumadocs or custom Geist docs site to package-backed Geistdocs
4
4
  type: guide
5
5
  summary: Move an existing documentation site to @vercel/geistdocs while keeping local content, routing, middleware behavior, and AI-readable surfaces intact.
@@ -14,6 +14,10 @@ related:
14
14
 
15
15
  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.
16
16
 
17
+ <Callout title="Already use Geistdocs 1.x?">
18
+ 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.
19
+ </Callout>
20
+
17
21
  <CopyPrompt text="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.">
18
22
  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.
19
23
  </CopyPrompt>
@@ -85,6 +85,10 @@ Create ordered lists with numbers:
85
85
  2. Second step
86
86
  3. Third step
87
87
 
88
+ ### Steps
89
+
90
+ Headings that start with a number, such as `### 1. Install the CLI`, render as a numbered step list with a counter beside each heading. See [Steps](/docs/components/steps) for the grouping rules and the `Steps` and `Step` components.
91
+
88
92
  ### Blockquotes
89
93
 
90
94
  Use `>` to create blockquotes:
@@ -215,6 +219,44 @@ Add images with `![alt text](url)`:
215
219
  ![Description of the image](/path/to/image.png)
216
220
  ```
217
221
 
222
+ Use `<Image>` when an image needs the standard documentation presentation and
223
+ an optional description. It uses Geistcn's image component without a lightbox
224
+ or other interaction:
225
+
226
+ ```mdx
227
+ <Image
228
+ alt="Deployment graph"
229
+ caption="Requests move from the edge to the selected region."
230
+ height={480}
231
+ src="/deployment-graph.png"
232
+ width={800}
233
+ />
234
+ ```
235
+
236
+ This renders as:
237
+
238
+ <Image
239
+ alt="Navigation Inspector showing a loading shell for a page load"
240
+ caption="The Navigation Inspector paused on a page load."
241
+ height={389}
242
+ srcDark="https://h8DxKfmAPhn8O0p3.public.blob.vercel-storage.com/docs/dark/inspector-load.png"
243
+ srcLight="https://h8DxKfmAPhn8O0p3.public.blob.vercel-storage.com/docs/light/inspector-load.png"
244
+ width={472}
245
+ />
246
+
247
+ For theme-aware images, provide both sources:
248
+
249
+ ```mdx
250
+ <Image
251
+ alt="Deployment graph"
252
+ caption="Requests move from the edge to the selected region."
253
+ height={480}
254
+ srcDark="/deployment-graph-dark.png"
255
+ srcLight="/deployment-graph-light.png"
256
+ width={800}
257
+ />
258
+ ```
259
+
218
260
  ## GitHub Flavored Markdown
219
261
 
220
262
  Geistdocs supports GFM extensions including tables, task lists, and autolinks.
@@ -23,6 +23,15 @@ const environment = process.env.VERCEL_ENV ?? process.env.NODE_ENV;
23
23
  const envFavicon = ENV_FAVICONS[environment as keyof typeof ENV_FAVICONS];
24
24
 
25
25
  const config: NextConfig = {
26
+ images: {
27
+ remotePatterns: [
28
+ {
29
+ hostname: "h8dxkfmaphn8o0p3.public.blob.vercel-storage.com",
30
+ pathname: "/docs/**",
31
+ protocol: "https",
32
+ },
33
+ ],
34
+ },
26
35
  modularizeImports: {
27
36
  "@vercel/geistcn/components": {
28
37
  skipDefaultConversion: true,
@@ -17,9 +17,9 @@
17
17
  "@streamdown/code": "^1.0.1",
18
18
  "@vercel/agent-readability": "^0.7.0",
19
19
  "@vercel/analytics": "^1.6.1",
20
- "@vercel/geistcn": "1.0.3",
21
- "@vercel/geistcn-assets": "2.0.1",
22
- "@vercel/geistdocs": "1.25.1-canary.4e75e60",
20
+ "@vercel/geistcn": "1.0.4",
21
+ "@vercel/geistcn-assets": "2.1.0",
22
+ "@vercel/geistdocs": "1.25.1-canary.62250e6",
23
23
  "@vercel/speed-insights": "^1.3.1",
24
24
  "ai": "^6.0.132",
25
25
  "class-variance-authority": "^0.7.1",