@vercel/geistdocs 1.25.1-canary.eec231d → 1.25.1-canary.fb7a9dd
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/components/image.d.ts +19 -0
- package/dist/components/image.d.ts.map +1 -0
- package/dist/components/image.js +9 -0
- package/dist/components/steps.d.ts +9 -0
- package/dist/components/steps.d.ts.map +1 -0
- package/dist/components/steps.js +9 -0
- 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 +44 -10
- 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/chat/sources.d.ts +1 -1
- package/dist/internal/chat/sources.d.ts.map +1 -1
- package/dist/internal/chat/sources.js +6 -3
- package/dist/internal/link-href.d.ts +13 -0
- package/dist/internal/link-href.d.ts.map +1 -0
- package/dist/internal/link-href.js +51 -0
- package/dist/internal/mdx-to-markdown.d.ts +3 -0
- package/dist/internal/mdx-to-markdown.d.ts.map +1 -0
- package/dist/internal/mdx-to-markdown.js +166 -0
- package/dist/internal/mousedown-navigation-utils.d.ts +5 -0
- package/dist/internal/mousedown-navigation-utils.d.ts.map +1 -0
- package/dist/internal/mousedown-navigation-utils.js +95 -0
- package/dist/internal/mousedown-navigation.d.ts +10 -0
- package/dist/internal/mousedown-navigation.d.ts.map +1 -0
- package/dist/internal/mousedown-navigation.js +42 -0
- package/dist/internal/navbar/navbar-shell.d.ts.map +1 -1
- package/dist/internal/navbar/navbar-shell.js +2 -1
- package/dist/internal/provider-client.d.ts.map +1 -1
- package/dist/internal/provider-client.js +1 -11
- package/dist/internal/react-node-text.d.ts +4 -0
- package/dist/internal/react-node-text.d.ts.map +1 -0
- package/dist/internal/react-node-text.js +11 -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/internal/sidebar.d.ts.map +1 -1
- package/dist/internal/sidebar.js +15 -14
- package/dist/internal/table-of-contents-visibility.d.ts +27 -0
- package/dist/internal/table-of-contents-visibility.d.ts.map +1 -0
- package/dist/internal/table-of-contents-visibility.js +15 -0
- package/dist/internal/toc-items.d.ts.map +1 -1
- package/dist/internal/toc-items.js +2 -1
- package/dist/mdx.d.ts +1 -0
- package/dist/mdx.d.ts.map +1 -1
- package/dist/mdx.js +5 -0
- package/dist/page.d.ts +35 -0
- package/dist/page.d.ts.map +1 -0
- package/dist/page.js +26 -0
- package/dist/pages/docs.d.ts +6 -0
- package/dist/pages/docs.d.ts.map +1 -1
- package/dist/pages/docs.js +28 -15
- package/dist/routes/chat.d.ts.map +1 -1
- package/dist/routes/chat.js +30 -13
- package/dist/routes/llms.d.ts +1 -1
- package/dist/routes/llms.d.ts.map +1 -1
- package/dist/routes/llms.js +12 -2
- package/dist/source-config.d.ts +11 -0
- package/dist/source-config.d.ts.map +1 -1
- package/dist/source-config.js +21 -2
- package/dist/source.d.ts +10 -1
- package/dist/source.d.ts.map +1 -1
- package/dist/source.js +75 -34
- package/dist/versions.js +2 -2
- package/docs/agents.md +6 -3
- package/docs/llms.txt +464 -28
- package/docs/manifest.json +30 -3
- package/docs/pages/components/steps.md +129 -0
- package/docs/pages/deployment.md +30 -5
- package/docs/pages/getting-started.md +38 -12
- package/docs/pages/guides/hidden-outline.md +31 -0
- package/docs/pages/guides/nested-navigation.md +1 -1
- package/docs/pages/md.md +24 -5
- package/docs/pages/migration-2.md +106 -0
- package/docs/pages/migration.md +5 -2
- package/docs/pages/syntax.md +42 -0
- package/docs/pages/table-of-contents.md +40 -0
- package/docs/sitemap.md +5 -2
- package/package.json +19 -5
- package/source-config.js +38 -2
- package/template/app/[lang]/docs/custom-page/page.tsx +49 -0
- package/template/content/docs/components/meta.json +4 -0
- package/template/content/docs/components/steps.mdx +125 -0
- package/template/content/docs/deployment.mdx +31 -6
- package/template/content/docs/getting-started.mdx +39 -13
- package/template/content/docs/guides/hidden-outline.mdx +28 -0
- package/template/content/docs/guides/meta.json +1 -1
- package/template/content/docs/guides/nested-navigation.mdx +1 -1
- package/template/content/docs/md.mdx +24 -5
- package/template/content/docs/meta.json +3 -0
- package/template/content/docs/migration-2.mdx +106 -0
- package/template/content/docs/migration.mdx +5 -1
- package/template/content/docs/syntax.mdx +42 -0
- package/template/content/docs/table-of-contents.mdx +40 -0
- package/template/next.config.ts +9 -0
- package/template/package.json +4 -4
- package/theme.css +56 -4
|
@@ -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
|
|
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
|
-
-
|
|
35
|
-
- The full
|
|
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
|
-
-
|
|
85
|
-
-
|
|
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:
|
|
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 ``:
|
|
|
215
219
|

|
|
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.
|
|
@@ -52,6 +52,46 @@ Use `####` when a sub-section needs its own breakdown. Geistdocs indents each le
|
|
|
52
52
|
|
|
53
53
|
On mobile, Geistdocs replaces the sidebar outline with a compact menu in the page bar. The menu lists the same headings as a flat, indented list without the guide rail, so it stays legible on narrow screens.
|
|
54
54
|
|
|
55
|
+
## Hide the outline on a page
|
|
56
|
+
|
|
57
|
+
Set `tableOfContents: false` in the frontmatter to hide the outline on pages that do not benefit from it, such as overviews built from cards or short pages with one or two sections. The content then spans the column the outline would have used, so the page keeps the same right edge as every other page. Page actions and previous and next links stay in place.
|
|
58
|
+
|
|
59
|
+
```yaml
|
|
60
|
+
---
|
|
61
|
+
title: Overview
|
|
62
|
+
tableOfContents: false
|
|
63
|
+
---
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Frontmatter wins over the app-level `tableOfContent.enabled` option passed to `createDocsPage`. See [Hide the outline](/docs/guides/hidden-outline) for a page that sets `tableOfContents: false`.
|
|
67
|
+
|
|
68
|
+
## Use the outline in custom pages
|
|
69
|
+
|
|
70
|
+
Routes you build in TSX inside the docs layout, such as a landing page, do not go through `createDocsPage`. Wrap their content in `GeistdocsPage` from `@vercel/geistdocs/page` to get the same layout and outline behavior as MDX pages. Pass `tableOfContents={false}` to hide the outline and let the content span its column.
|
|
71
|
+
|
|
72
|
+
```tsx title="app/[lang]/docs/overview/page.tsx"
|
|
73
|
+
import {
|
|
74
|
+
GeistdocsPage,
|
|
75
|
+
GeistdocsPageBody,
|
|
76
|
+
GeistdocsPageDescription,
|
|
77
|
+
GeistdocsPageTitle,
|
|
78
|
+
} from "@vercel/geistdocs/page";
|
|
79
|
+
|
|
80
|
+
export default function OverviewPage() {
|
|
81
|
+
return (
|
|
82
|
+
<GeistdocsPage tableOfContents={false}>
|
|
83
|
+
<GeistdocsPageTitle>Overview</GeistdocsPageTitle>
|
|
84
|
+
<GeistdocsPageDescription>
|
|
85
|
+
Start here to find the right guide.
|
|
86
|
+
</GeistdocsPageDescription>
|
|
87
|
+
<GeistdocsPageBody>{/* cards, links, or other content */}</GeistdocsPageBody>
|
|
88
|
+
</GeistdocsPage>
|
|
89
|
+
);
|
|
90
|
+
}
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
The template includes this pattern at [/docs/custom-page](/docs/custom-page). `GeistdocsPage` accepts `toc` (outline items, usually the `toc` export of a compiled MDX page), `breadcrumb`, and `footer`. Pass an object to `tableOfContents` to add a `header` or `footer` around a visible outline. `GeistdocsPageBody` applies the prose styles that MDX content uses.
|
|
94
|
+
|
|
55
95
|
## Write scannable headings
|
|
56
96
|
|
|
57
97
|
Keep headings short and descriptive so the outline reads like a summary of the page. Name each heading after the goal of its section, and avoid stacking two headings with no content between them.
|
package/template/next.config.ts
CHANGED
|
@@ -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,
|
package/template/package.json
CHANGED
|
@@ -15,11 +15,11 @@
|
|
|
15
15
|
"@orama/tokenizers": "^3.1.16",
|
|
16
16
|
"@streamdown/cjk": "^1.0.1",
|
|
17
17
|
"@streamdown/code": "^1.0.1",
|
|
18
|
-
"@vercel/agent-readability": "^0.
|
|
18
|
+
"@vercel/agent-readability": "^0.7.0",
|
|
19
19
|
"@vercel/analytics": "^1.6.1",
|
|
20
|
-
"@vercel/geistcn": "1.0.
|
|
21
|
-
"@vercel/geistcn-assets": "2.0
|
|
22
|
-
"@vercel/geistdocs": "1.25.1-canary.
|
|
20
|
+
"@vercel/geistcn": "1.0.4",
|
|
21
|
+
"@vercel/geistcn-assets": "2.1.0",
|
|
22
|
+
"@vercel/geistdocs": "1.25.1-canary.fb7a9dd",
|
|
23
23
|
"@vercel/speed-insights": "^1.3.1",
|
|
24
24
|
"ai": "^6.0.132",
|
|
25
25
|
"class-variance-authority": "^0.7.1",
|
package/theme.css
CHANGED
|
@@ -60,6 +60,56 @@ button:not(:disabled, [aria-disabled="true"]) {
|
|
|
60
60
|
padding-left: 0.5rem;
|
|
61
61
|
}
|
|
62
62
|
|
|
63
|
+
/* Numbered steps. Overrides the fumadocs rail-and-disc layout with a bordered
|
|
64
|
+
Geist counter aligned to each step heading. Emitted by remarkSteps for
|
|
65
|
+
`### 1. Title` headings and by the Steps/Step components. */
|
|
66
|
+
.prose .fd-steps {
|
|
67
|
+
--geistdocs-step-size: 1.75rem;
|
|
68
|
+
padding-left: 0;
|
|
69
|
+
margin-top: 1.5rem;
|
|
70
|
+
margin-left: 0;
|
|
71
|
+
counter-reset: step;
|
|
72
|
+
border-left: 0;
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
.prose .fd-step {
|
|
76
|
+
position: relative;
|
|
77
|
+
padding-bottom: 2rem;
|
|
78
|
+
padding-left: calc(var(--geistdocs-step-size) + 0.75rem);
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
.prose .fd-step:last-child {
|
|
82
|
+
padding-bottom: 0;
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
.prose .fd-step::before {
|
|
86
|
+
position: absolute;
|
|
87
|
+
top: -1px;
|
|
88
|
+
left: 0;
|
|
89
|
+
display: flex;
|
|
90
|
+
align-items: center;
|
|
91
|
+
justify-content: center;
|
|
92
|
+
width: var(--geistdocs-step-size);
|
|
93
|
+
height: var(--geistdocs-step-size);
|
|
94
|
+
font-size: 0.8125rem;
|
|
95
|
+
font-weight: 500;
|
|
96
|
+
line-height: 1;
|
|
97
|
+
color: var(--ds-gray-1000);
|
|
98
|
+
content: counter(step);
|
|
99
|
+
counter-increment: step;
|
|
100
|
+
background-color: var(--ds-background-100);
|
|
101
|
+
border: 1px solid var(--ds-gray-400);
|
|
102
|
+
border-radius: 9999px;
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
.prose .fd-step > :first-child {
|
|
106
|
+
margin-top: 0;
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
.prose .fd-step > :last-child {
|
|
110
|
+
margin-bottom: 0;
|
|
111
|
+
}
|
|
112
|
+
|
|
63
113
|
#nd-page h1:not(:where(.prose *)) {
|
|
64
114
|
@apply text-heading-40 tracking-tighter;
|
|
65
115
|
}
|
|
@@ -69,6 +119,12 @@ button:not(:disabled, [aria-disabled="true"]) {
|
|
|
69
119
|
max-width: 780px;
|
|
70
120
|
transform: translateX(-20px);
|
|
71
121
|
}
|
|
122
|
+
|
|
123
|
+
/* Pages without an outline (`tableOfContents: false`) extend the content
|
|
124
|
+
across the column the outline would have used. */
|
|
125
|
+
#nd-page[data-full="true"] {
|
|
126
|
+
max-width: calc(780px + var(--geistdocs-toc-column, 268px));
|
|
127
|
+
}
|
|
72
128
|
}
|
|
73
129
|
|
|
74
130
|
@layer utilities {
|
|
@@ -227,10 +283,6 @@ button:not(:disabled, [aria-disabled="true"]) {
|
|
|
227
283
|
}
|
|
228
284
|
}
|
|
229
285
|
|
|
230
|
-
[data-geistdocs-command-modal] {
|
|
231
|
-
box-shadow: var(--ds-shadow-modal);
|
|
232
|
-
}
|
|
233
|
-
|
|
234
286
|
[data-geistdocs-command-modal] .text-fd-muted-foreground {
|
|
235
287
|
color: var(--ds-gray-900);
|
|
236
288
|
}
|