@vercel/geistdocs 1.12.0 → 1.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. package/dist/cli/index.js +1 -1
  2. package/dist/controls.d.ts.map +1 -1
  3. package/dist/controls.js +7 -5
  4. package/dist/home-layout.d.ts.map +1 -1
  5. package/dist/home-layout.js +2 -7
  6. package/dist/internal/page-actions-client.js +1 -1
  7. package/dist/internal/provider-client.d.ts.map +1 -1
  8. package/dist/internal/provider-client.js +1 -1
  9. package/dist/internal/sidebar-responsive.d.ts +3 -0
  10. package/dist/internal/sidebar-responsive.d.ts.map +1 -0
  11. package/dist/internal/sidebar-responsive.js +10 -0
  12. package/dist/internal/sidebar-tree.d.ts +23 -0
  13. package/dist/internal/sidebar-tree.d.ts.map +1 -0
  14. package/dist/internal/sidebar-tree.js +115 -0
  15. package/dist/internal/sidebar.d.ts +2 -5
  16. package/dist/internal/sidebar.d.ts.map +1 -1
  17. package/dist/internal/sidebar.js +282 -44
  18. package/dist/internal/table-of-contents.js +1 -1
  19. package/dist/internal/ui/sheet.d.ts.map +1 -1
  20. package/dist/internal/ui/sheet.js +2 -2
  21. package/dist/layout.d.ts.map +1 -1
  22. package/dist/layout.js +1 -6
  23. package/dist/mdx.d.ts +1 -0
  24. package/dist/mdx.d.ts.map +1 -1
  25. package/dist/mobile-docs-bar.d.ts.map +1 -1
  26. package/dist/mobile-docs-bar.js +3 -3
  27. package/dist/navbar.js +1 -1
  28. package/dist/pages/docs.js +1 -1
  29. package/dist/source-config.d.ts +1 -0
  30. package/dist/source-config.d.ts.map +1 -1
  31. package/dist/source-config.js +1 -0
  32. package/dist/source.d.ts +1 -0
  33. package/dist/source.d.ts.map +1 -1
  34. package/dist/source.js +21 -2
  35. package/dist/versions.d.ts.map +1 -1
  36. package/dist/versions.js +3 -3
  37. package/docs/agents.md +2 -2
  38. package/docs/llms.txt +197 -30
  39. package/docs/manifest.json +10 -9
  40. package/docs/pages/configuration.md +3 -0
  41. package/docs/pages/getting-started.md +2 -0
  42. package/docs/pages/guides/nested-navigation.md +174 -13
  43. package/docs/pages/syntax.md +2 -1
  44. package/docs/sitemap.md +1 -1
  45. package/package.json +1 -1
  46. package/source-config.js +1 -0
  47. package/template/app/styles/geistdocs.css +8 -6
  48. package/template/content/docs/configuration.mdx +3 -0
  49. package/template/content/docs/getting-started.mdx +2 -0
  50. package/template/content/docs/guides/nested-navigation.mdx +174 -12
  51. package/template/content/docs/syntax.mdx +2 -1
  52. package/template/package.json +1 -1
  53. package/theme.css +150 -0
@@ -1 +1 @@
1
- {"version":3,"file":"versions.d.ts","sourceRoot":"","sources":["../src/versions.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AACvC,OAAO,KAAK,EAAE,sBAAsB,EAAE,uBAAuB,EAAE,MAAM,UAAU,CAAC;AAShF,MAAM,WAAW,wBAAwB;IACvC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,UAAU,uBAAuB,CAAC,IAAI,SAAS,wBAAwB;IACrE,WAAW,CAAC,EAAE,IAAI,CAAC;IACnB,IAAI,EAAE,IAAI,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,UAAU,yBAAyB;IACjC,cAAc,CAAC,EAAE,sBAAsB,CAAC;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,sBAAsB,CAAC;CACjC;AAED,UAAU,yBAAyB,CAAC,IAAI,SAAS,wBAAwB;IACvE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE;QAAE,MAAM,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,IAAI,CAAA;KAAE,KAAK,SAAS,CAAC;IACzE,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE;QAAE,MAAM,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,IAAI,CAAA;KAAE,KAAK,SAAS,CAAC;CACtE;AAED,UAAU,2BAA2B;IACnC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,sBAAsB,EAAE,GAAG,uBAAuB,CAAC;CAC9D;AA0ED,eAAO,MAAM,gBAAgB,GAAI,IAAI,SAAS,wBAAwB,EAAE,kCAIrE,uBAAuB,CAAC,IAAI,CAAC,WAmB/B,CAAC;AAEF,eAAO,MAAM,kBAAkB,GAAI,wCAIhC,yBAAyB,WACgD,CAAC;AAE7E,eAAO,MAAM,oBAAoB,GAAI,IAAI,SAAS,wBAAwB,EAAE,uEAOzE,yBAAyB,CAAC,IAAI,CAAC,mDAyFjC,CAAC;AAEF,eAAO,MAAM,sBAAsB,GAAI,mCAIpC,2BAA2B,4CAuB7B,CAAC"}
1
+ {"version":3,"file":"versions.d.ts","sourceRoot":"","sources":["../src/versions.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AACvC,OAAO,KAAK,EAAE,sBAAsB,EAAE,uBAAuB,EAAE,MAAM,UAAU,CAAC;AAShF,MAAM,WAAW,wBAAwB;IACvC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,UAAU,uBAAuB,CAAC,IAAI,SAAS,wBAAwB;IACrE,WAAW,CAAC,EAAE,IAAI,CAAC;IACnB,IAAI,EAAE,IAAI,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,UAAU,yBAAyB;IACjC,cAAc,CAAC,EAAE,sBAAsB,CAAC;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,sBAAsB,CAAC;CACjC;AAED,UAAU,yBAAyB,CAAC,IAAI,SAAS,wBAAwB;IACvE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE;QAAE,MAAM,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,IAAI,CAAA;KAAE,KAAK,SAAS,CAAC;IACzE,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE;QAAE,MAAM,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,IAAI,CAAA;KAAE,KAAK,SAAS,CAAC;CACtE;AAED,UAAU,2BAA2B;IACnC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,sBAAsB,EAAE,GAAG,uBAAuB,CAAC;CAC9D;AA0ED,eAAO,MAAM,gBAAgB,GAAI,IAAI,SAAS,wBAAwB,EAAE,kCAIrE,uBAAuB,CAAC,IAAI,CAAC,WAmB/B,CAAC;AAEF,eAAO,MAAM,kBAAkB,GAAI,wCAIhC,yBAAyB,WACgD,CAAC;AAE7E,eAAO,MAAM,oBAAoB,GAAI,IAAI,SAAS,wBAAwB,EAAE,uEAOzE,yBAAyB,CAAC,IAAI,CAAC,mDA0FjC,CAAC;AAEF,eAAO,MAAM,sBAAsB,GAAI,mCAIpC,2BAA2B,4CAuB7B,CAAC"}
package/dist/versions.js CHANGED
@@ -17,7 +17,7 @@ const removeRoutePrefix = (pathname, item) => {
17
17
  : pathname;
18
18
  };
19
19
  const getVersionDescription = ({ current, version, }) => version.description ?? (current ? "Current version" : "Previous version");
20
- const SelectIcon = ({ active, children, }) => (_jsx("span", { className: cn("flex size-9 shrink-0 items-center justify-center rounded-lg border", active
20
+ const SelectIcon = ({ active, children, }) => (_jsx("span", { className: cn("flex size-9 shrink-0 items-center justify-center rounded-md border", active
21
21
  ? "border-blue-500 bg-blue-100 text-blue-900"
22
22
  : "border-gray-alpha-400 bg-gray-100 text-gray-800"), children: children }));
23
23
  const VersionIcon = ({ active }) => {
@@ -66,10 +66,10 @@ export const GeistdocsRouteSelect = ({ ariaLabel = "Select route", className, cu
66
66
  const currentDescription = currentItem
67
67
  ? getDescription({ active: true, item: currentItem })
68
68
  : null;
69
- return (_jsxs(DropdownMenu, { children: [_jsx(DropdownMenuTrigger, { asChild: true, children: _jsxs("button", { "aria-label": ariaLabel, className: cn("group flex w-full items-center gap-3 rounded-xl px-2 py-2 text-left outline-none transition-colors hover:bg-gray-100 focus-visible:ring-2 focus-visible:ring-blue-700", className), type: "button", children: [currentItem ? renderIcon({ active: true, item: currentItem }) : null, _jsxs("span", { className: "min-w-0 flex-1", children: [_jsx("span", { className: "block truncate font-medium text-gray-1000 text-sm leading-5", children: currentItem?.label ?? currentId }), currentDescription ? (_jsx("span", { className: "block truncate text-gray-800 text-sm leading-5", children: currentDescription })) : null] }), _jsx(ChevronDownIcon, { className: "size-4 shrink-0 text-gray-900 transition-transform group-data-[state=open]:rotate-180" })] }) }), _jsx(DropdownMenuContent, { align: "start", className: "w-(--radix-dropdown-menu-trigger-width) min-w-64 rounded-xl bg-background-100 p-1 shadow-(--ds-shadow-menu)", children: items.map((item) => {
69
+ return (_jsxs(DropdownMenu, { children: [_jsx(DropdownMenuTrigger, { asChild: true, children: _jsxs("button", { "aria-label": ariaLabel, className: cn("group flex w-full items-center gap-2 rounded-md px-2 py-2 text-left outline-none transition-colors duration-150 ease-[cubic-bezier(0.175,0.885,0.32,1.1)] hover:bg-gray-alpha-100 focus-visible:shadow-[var(--ds-focus-ring)] active:bg-gray-alpha-300 data-[state=open]:bg-gray-alpha-100 motion-reduce:transition-none", className), type: "button", children: [currentItem ? renderIcon({ active: true, item: currentItem }) : null, _jsxs("span", { className: "min-w-0 flex-1", children: [_jsx("span", { className: "block truncate text-button-14 text-gray-1000", children: currentItem?.label ?? currentId }), currentDescription ? (_jsx("span", { className: "block truncate text-gray-900 text-label-13", children: currentDescription })) : null] }), _jsx(ChevronDownIcon, { className: "size-4 shrink-0 text-gray-900 transition-transform duration-150 ease-[cubic-bezier(0.175,0.885,0.32,1.1)] group-data-[state=open]:rotate-180 motion-reduce:transition-none" })] }) }), _jsx(DropdownMenuContent, { align: "start", className: "w-(--radix-dropdown-menu-trigger-width) min-w-64 rounded-xl bg-background-100 p-1 shadow-(--ds-shadow-menu)", children: items.map((item) => {
70
70
  const active = item.id === currentId;
71
71
  const description = getDescription({ active, item });
72
- return (_jsxs(DropdownMenuItem, { className: "flex cursor-pointer items-center gap-3 rounded-lg px-2 py-2", onSelect: () => navigateToItem(item), children: [renderIcon({ active, item }), _jsxs("span", { className: "min-w-0 flex-1", children: [_jsx("span", { className: "block truncate font-medium text-gray-1000 text-sm leading-5", children: item.label }), description ? (_jsx("span", { className: "block truncate text-gray-800 text-sm leading-5", children: description })) : null] }), active ? _jsx(CheckIcon, { className: "size-4 text-blue-900" }) : null] }, item.id));
72
+ return (_jsxs(DropdownMenuItem, { "aria-current": active ? "page" : undefined, className: "flex cursor-pointer items-center gap-2 rounded-md px-2 py-2", onSelect: () => navigateToItem(item), children: [renderIcon({ active, item }), _jsxs("span", { className: "min-w-0 flex-1", children: [_jsx("span", { className: "block truncate text-button-14 text-gray-1000", children: item.label }), description ? (_jsx("span", { className: "block truncate text-gray-900 text-label-13", children: description })) : null] }), active ? _jsx(CheckIcon, { className: "size-4 text-blue-900" }) : null] }, item.id));
73
73
  }) })] }));
74
74
  };
75
75
  export const GeistdocsVersionSelect = ({ className, current, versions, }) => {
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.12.0 so agents can understand the installed package without web access.
3
+ These docs are bundled with `@vercel/geistdocs` 1.13.0 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
@@ -35,11 +35,11 @@ They are generated from `apps/template/content/docs` during the package build.
35
35
  - [.md Extension](pages/md.md): Access any documentation page as raw Markdown by appending .md or .mdx to the URL for AI tool consumption.
36
36
  - [Agent readiness](pages/agent-readiness.md): Generate /agents.md and /.well-known/mcp.json from Geistdocs config so agents can find docs, Markdown surfaces, API specs, and MCP endpoints.
37
37
  - [Ask AI](pages/ask-ai.md): An AI-powered chat assistant with context-aware search, persistent history, and suggested prompts for your documentation.
38
+ - [Configure sidebar navigation](pages/guides/nested-navigation.md): Configure sidebar order, section labels, folder landing pages, and deeply nested page trees with meta.json files.
38
39
  - [Edit on GitHub](pages/edit-on-github.md): A direct link on every documentation page that lets readers propose changes through GitHub pull requests.
39
40
  - [Feedback](pages/feedback.md): An interactive feedback widget that collects user sentiment and creates structured GitHub Issues automatically.
40
41
  - [Internationalization](pages/internationalization.md): Serve documentation in multiple languages with automatic translation via the Geistdocs CLI and Fumadocs routing.
41
42
  - [llms.txt](pages/llms-txt.md): A single endpoint that returns all documentation as plain Markdown text following the llms.txt standard.
42
- - [Nested navigation](pages/guides/nested-navigation.md): How Geistdocs builds breadcrumbs from your page tree.
43
43
  - [Open in Chat](pages/open-in-chat.md): Transfer documentation context to AI chat platforms like ChatGPT, Claude, Cursor, and v0 with a single click.
44
44
  - [RSS](pages/rss.md): An automatically generated RSS 2.0 feed that keeps users informed when documentation is published or updated.
45
45
  - [Theme-Aware Image](pages/theme-aware-image.md): A component that swaps images based on the active theme, built on top of Next.js Image.
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.12.0.
3
+ These docs are bundled with `@vercel/geistdocs` 1.13.0.
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
@@ -18,11 +18,11 @@ They describe how to build package-backed Geistdocs sites and how to use the pac
18
18
  - [.md Extension](pages/md.md): Access any documentation page as raw Markdown by appending .md or .mdx to the URL for AI tool consumption.
19
19
  - [Agent readiness](pages/agent-readiness.md): Generate /agents.md and /.well-known/mcp.json from Geistdocs config so agents can find docs, Markdown surfaces, API specs, and MCP endpoints.
20
20
  - [Ask AI](pages/ask-ai.md): An AI-powered chat assistant with context-aware search, persistent history, and suggested prompts for your documentation.
21
+ - [Configure sidebar navigation](pages/guides/nested-navigation.md): Configure sidebar order, section labels, folder landing pages, and deeply nested page trees with meta.json files.
21
22
  - [Edit on GitHub](pages/edit-on-github.md): A direct link on every documentation page that lets readers propose changes through GitHub pull requests.
22
23
  - [Feedback](pages/feedback.md): An interactive feedback widget that collects user sentiment and creates structured GitHub Issues automatically.
23
24
  - [Internationalization](pages/internationalization.md): Serve documentation in multiple languages with automatic translation via the Geistdocs CLI and Fumadocs routing.
24
25
  - [llms.txt](pages/llms-txt.md): A single endpoint that returns all documentation as plain Markdown text following the llms.txt standard.
25
- - [Nested navigation](pages/guides/nested-navigation.md): How Geistdocs builds breadcrumbs from your page tree.
26
26
  - [Open in Chat](pages/open-in-chat.md): Transfer documentation context to AI chat platforms like ChatGPT, Claude, Cursor, and v0 with a single click.
27
27
  - [RSS](pages/rss.md): An automatically generated RSS 2.0 feed that keeps users informed when documentation is published or updated.
28
28
  - [Theme-Aware Image](pages/theme-aware-image.md): A component that swaps images based on the active theme, built on top of Next.js Image.
@@ -224,6 +224,8 @@ Use `content/docs/meta.json` to control page order and groups:
224
224
  }
225
225
  ```
226
226
 
227
+ Page and folder entries use names without extensions. A value such as `---Guides---` creates a non-clickable separator label. Read [Configure sidebar navigation](/docs/guides/nested-navigation) to add folder landing pages, deeply nested folders, custom links, and `defaultOpen` behavior.
228
+
227
229
  ## Configure the site
228
230
 
229
231
  Use `geistdocs.tsx` to customize the site shell:
@@ -768,6 +770,7 @@ related:
768
770
  - /docs/migration
769
771
  - /docs/provider
770
772
  - /docs/env
773
+ - /docs/guides/nested-navigation
771
774
  - /docs/versioned-docs
772
775
  - /docs/proxy
773
776
  ---
@@ -797,6 +800,8 @@ Configure Geistdocs through user-owned files in the generated project. Runtime f
797
800
  | `proxy.ts` | Configures markdown negotiation, AI-agent rewrites, request tracking, and custom request hooks. |
798
801
  | `content/docs/meta.json` | Controls sidebar order and section labels. |
799
802
 
803
+ Read [Configure sidebar navigation](/docs/guides/nested-navigation) for page ordering, titled separators, folder indexes, nested folders, and custom navigation links.
804
+
800
805
  ## `geistdocs.tsx`
801
806
 
802
807
  The root `geistdocs.tsx` file is the primary configuration surface:
@@ -1068,10 +1073,11 @@ Every MDX file should include frontmatter at the top:
1068
1073
  ---
1069
1074
  title: Page Title
1070
1075
  description: A brief description of the page content
1076
+ badge: Beta
1071
1077
  ---
1072
1078
  ```
1073
1079
 
1074
- The `title` property is required and is used for the page heading and navigation. The `description` is used for SEO and page previews.
1080
+ The `title` property is required and is used for the page heading and navigation. The `description` is used for SEO and page previews. The optional `badge` appears beside the page label in desktop and mobile sidebar navigation.
1075
1081
 
1076
1082
  ## Basic Markdown
1077
1083
 
@@ -2378,6 +2384,194 @@ In default AI Gateway mode, Geistdocs uses `openai/gpt-4.1-mini` via the Vercel
2378
2384
  You can customize the initial suggested prompts shown to users. These are configured in the Geistdocs configuration file, which you can read more about in the [Configuration](/docs/configuration) section.
2379
2385
 
2380
2386
 
2387
+ ---
2388
+
2389
+ ---
2390
+ title: Configure sidebar navigation
2391
+ description: Organize Geistdocs pages with ordered groups, separators, folder indexes, and nested navigation
2392
+ type: guide
2393
+ summary: Configure sidebar order, section labels, folder landing pages, and deeply nested page trees with meta.json files.
2394
+ url: /docs/guides/nested-navigation
2395
+ source: apps/template/content/docs/guides/nested-navigation.mdx
2396
+ prerequisites:
2397
+ - /docs/getting-started
2398
+ related:
2399
+ - /docs/configuration
2400
+ - /docs/syntax
2401
+ ---
2402
+
2403
+ # Configure sidebar navigation
2404
+
2405
+ Use `meta.json` files to organize the Geistdocs sidebar without changing layout components. Each `meta.json` controls the pages and folders in its own directory, so the same pattern works at every nesting level.
2406
+
2407
+ ## Start with the content tree
2408
+
2409
+ Directories become sidebar folders, and `.mdx` files become pages. The examples on this page use the following content tree:
2410
+
2411
+ ```text
2412
+ content/docs/
2413
+ ├── index.mdx
2414
+ ├── getting-started.mdx
2415
+ ├── architecture.mdx
2416
+ ├── api-reference.mdx
2417
+ ├── changelog.mdx
2418
+ ├── meta.json
2419
+ └── guides/
2420
+ ├── index.mdx
2421
+ ├── quickstarts.mdx
2422
+ ├── meta.json
2423
+ └── integrations/
2424
+ ├── nextjs.mdx
2425
+ ├── sveltekit.mdx
2426
+ ├── meta.json
2427
+ └── advanced/
2428
+ ├── index.mdx
2429
+ ├── caching.mdx
2430
+ ├── security.mdx
2431
+ └── meta.json
2432
+ ```
2433
+
2434
+ Every page needs a frontmatter `title`. Add a `description` to summarize the page. For a regular page, the frontmatter title becomes its sidebar label. Folder landing pages use the folder behavior described below.
2435
+
2436
+ ## Order top-level pages and add separators
2437
+
2438
+ Add page and folder names to the root `pages` array without file extensions:
2439
+
2440
+ ```json title="content/docs/meta.json"
2441
+ {
2442
+ "title": "My Product Documentation",
2443
+ "root": true,
2444
+ "pages": [
2445
+ "index",
2446
+ "getting-started",
2447
+ "---Guides---",
2448
+ "guides",
2449
+ "---Internals---",
2450
+ "architecture",
2451
+ "api-reference",
2452
+ "---Resources---",
2453
+ "..."
2454
+ ]
2455
+ }
2456
+ ```
2457
+
2458
+ This configuration produces three labeled groups after the two introductory pages:
2459
+
2460
+ - `---Guides---` adds a non-clickable **Guides** separator before the `guides` folder.
2461
+ - `---Internals---` adds an **Internals** separator before the architecture and API reference pages.
2462
+ - `---Resources---` adds a **Resources** separator before pages inserted by `...`.
2463
+
2464
+ The `...` entry inserts every page or folder that is not named elsewhere in the array. Place it where the remaining items should appear. Without `...`, unnamed items do not appear in that folder's sidebar navigation.
2465
+
2466
+ On desktop, top-level folders open as dedicated sidebar sections. On mobile, Geistdocs renders the same page tree as expandable nested navigation. Both layouts use the same `meta.json` files.
2467
+
2468
+ ## Add a folder landing page
2469
+
2470
+ Create `index.mdx` inside a nested directory when the folder needs its own landing page:
2471
+
2472
+ ```mdx title="content/docs/guides/index.mdx"
2473
+ ---
2474
+ title: Guides
2475
+ description: Follow task-focused guides for My Product.
2476
+ ---
2477
+
2478
+ Choose a guide based on the workflow you want to complete.
2479
+ ```
2480
+
2481
+ Then order the folder's child pages in its `meta.json`:
2482
+
2483
+ ```json title="content/docs/guides/meta.json"
2484
+ {
2485
+ "title": "Guides",
2486
+ "pages": ["quickstarts", "integrations"]
2487
+ }
2488
+ ```
2489
+
2490
+ Leave `index` out of a nested folder's `pages` array to use `index.mdx` as the folder landing page. In the desktop section view, Geistdocs exposes a top-level folder index as **Overview**. For a nested folder, the folder label links to its index while the disclosure control expands its children.
2491
+
2492
+ If you include `index` explicitly in `pages`, Geistdocs treats it as a regular child page instead of the folder landing page.
2493
+
2494
+ ## Configure deeply nested folders
2495
+
2496
+ Add another `meta.json` inside each nested directory. For the `integrations` folder from the example tree, group framework pages separately from advanced topics:
2497
+
2498
+ ```json title="content/docs/guides/integrations/meta.json"
2499
+ {
2500
+ "title": "Integrations",
2501
+ "defaultOpen": true,
2502
+ "pages": [
2503
+ "---Frameworks---",
2504
+ "nextjs",
2505
+ "sveltekit",
2506
+ "---Advanced---",
2507
+ "advanced"
2508
+ ]
2509
+ }
2510
+ ```
2511
+
2512
+ The `advanced` directory can define another level:
2513
+
2514
+ ```json title="content/docs/guides/integrations/advanced/meta.json"
2515
+ {
2516
+ "title": "Advanced Integrations",
2517
+ "pages": ["caching", "security"]
2518
+ }
2519
+ ```
2520
+
2521
+ Because `advanced/index.mdx` exists and is not listed in `pages`, **Advanced Integrations** links to `/docs/guides/integrations/advanced`. Its child pages resolve to:
2522
+
2523
+ - `/docs/guides/integrations/advanced/caching`
2524
+ - `/docs/guides/integrations/advanced/security`
2525
+
2526
+ Set `defaultOpen` to `true` when a folder should start expanded. Geistdocs also opens the folders that contain the active page, unless a folder explicitly sets `defaultOpen` to `false`.
2527
+
2528
+ ## Add a badge to a page
2529
+
2530
+ Add a short `badge` value to page frontmatter to show status or availability beside its sidebar label:
2531
+
2532
+ ```yaml title="content/docs/guides/new-api.mdx"
2533
+ ---
2534
+ title: New API
2535
+ description: Use the new API in your application.
2536
+ badge: Beta
2537
+ ---
2538
+ ```
2539
+
2540
+ Geistdocs renders the badge in desktop and mobile navigation. Badges also appear on folder landing pages because their sidebar items use the folder's `index.mdx` frontmatter. Keep badge text short so the page label has enough room to remain readable.
2541
+
2542
+ ## Add links to the navigation
2543
+
2544
+ The `pages` array can include internal and external links alongside content files:
2545
+
2546
+ ```json title="content/docs/meta.json"
2547
+ {
2548
+ "pages": [
2549
+ "index",
2550
+ "[Status](/status)",
2551
+ "external:[GitHub](https://github.com/my-org/my-repo)"
2552
+ ]
2553
+ }
2554
+ ```
2555
+
2556
+ Use `[Label](/path)` for an internal link. Prefix an external link with `external:` so Geistdocs opens it in a new tab and shows the external-link indicator.
2557
+
2558
+ ## Check breadcrumbs for nested pages
2559
+
2560
+ Geistdocs builds breadcrumbs from the same page tree. A page at `content/docs/guides/integrations/advanced/caching.mdx` receives the folder path **Guides**, **Integrations**, and **Advanced Integrations** before its page title.
2561
+
2562
+ Breadcrumbs render on the server from the page URL and sidebar tree, so they are present in the initial HTML. Top-level pages have no folder ancestors and do not render a breadcrumb.
2563
+
2564
+ ## Troubleshoot missing navigation items
2565
+
2566
+ Check these rules when a page or folder does not appear where expected:
2567
+
2568
+ - Match each `pages` entry to a file or directory name without its extension.
2569
+ - Add a `meta.json` to every folder that needs custom ordering, separators, `defaultOpen` behavior, or a title override.
2570
+ - Add `...` when unlisted files and folders should remain visible.
2571
+ - Leave `index` out of a nested folder's `pages` array when it should act as the folder landing page.
2572
+ - Keep separator labels between three hyphens on each side, such as `---Internals---`.
2573
+
2574
+
2381
2575
  ---
2382
2576
 
2383
2577
  ---
@@ -2750,33 +2944,6 @@ The llms.txt standard is a simple convention that makes documentation more acces
2750
2944
  Learn more at [llmstxt.org](https://llmstxt.org/)
2751
2945
 
2752
2946
 
2753
- ---
2754
-
2755
- ---
2756
- title: Nested navigation
2757
- description: How Geistdocs builds breadcrumbs from your page tree.
2758
- type: guide
2759
- url: /docs/guides/nested-navigation
2760
- source: apps/template/content/docs/guides/nested-navigation.mdx
2761
- ---
2762
-
2763
- # Nested navigation
2764
-
2765
- Any page nested inside a folder shows a breadcrumb above its title, built
2766
- automatically from the page tree. This page lives under the **Guides** folder,
2767
- so the breadcrumb above reads _Guides_.
2768
-
2769
- ## How it works
2770
-
2771
- The breadcrumb lists the folder ancestors of the current page, in order. It is
2772
- rendered on the server from the page's URL and the sidebar tree, so it is
2773
- present in the initial HTML — the page title never shifts once the page
2774
- hydrates.
2775
-
2776
- Top-level pages (those not inside a folder) have no ancestors, so no breadcrumb
2777
- is shown.
2778
-
2779
-
2780
2947
  ---
2781
2948
 
2782
2949
  ---
@@ -125,6 +125,15 @@
125
125
  "type": "conceptual",
126
126
  "url": "/docs/ask-ai"
127
127
  },
128
+ {
129
+ "description": "Organize Geistdocs pages with ordered groups, separators, folder indexes, and nested navigation",
130
+ "path": "pages/guides/nested-navigation.md",
131
+ "source": "apps/template/content/docs/guides/nested-navigation.mdx",
132
+ "summary": "Configure sidebar order, section labels, folder landing pages, and deeply nested page trees with meta.json files.",
133
+ "title": "Configure sidebar navigation",
134
+ "type": "guide",
135
+ "url": "/docs/guides/nested-navigation"
136
+ },
128
137
  {
129
138
  "description": "Allow readers to contribute directly by editing documentation pages on GitHub",
130
139
  "path": "pages/edit-on-github.md",
@@ -161,14 +170,6 @@
161
170
  "type": "conceptual",
162
171
  "url": "/docs/llms-txt"
163
172
  },
164
- {
165
- "description": "How Geistdocs builds breadcrumbs from your page tree.",
166
- "path": "pages/guides/nested-navigation.md",
167
- "source": "apps/template/content/docs/guides/nested-navigation.mdx",
168
- "title": "Nested navigation",
169
- "type": "guide",
170
- "url": "/docs/guides/nested-navigation"
171
- },
172
173
  {
173
174
  "description": "Allow users to continue conversations in their preferred AI chat platform with a single click",
174
175
  "path": "pages/open-in-chat.md",
@@ -198,5 +199,5 @@
198
199
  }
199
200
  ],
200
201
  "source": "apps/template/content/docs",
201
- "version": "1.12.0"
202
+ "version": "1.13.0"
202
203
  }
@@ -11,6 +11,7 @@ related:
11
11
  - /docs/migration
12
12
  - /docs/provider
13
13
  - /docs/env
14
+ - /docs/guides/nested-navigation
14
15
  - /docs/versioned-docs
15
16
  - /docs/proxy
16
17
  ---
@@ -40,6 +41,8 @@ Configure Geistdocs through user-owned files in the generated project. Runtime f
40
41
  | `proxy.ts` | Configures markdown negotiation, AI-agent rewrites, request tracking, and custom request hooks. |
41
42
  | `content/docs/meta.json` | Controls sidebar order and section labels. |
42
43
 
44
+ Read [Configure sidebar navigation](/docs/guides/nested-navigation) for page ordering, titled separators, folder indexes, nested folders, and custom navigation links.
45
+
43
46
  ## `geistdocs.tsx`
44
47
 
45
48
  The root `geistdocs.tsx` file is the primary configuration surface:
@@ -90,6 +90,8 @@ Use `content/docs/meta.json` to control page order and groups:
90
90
  }
91
91
  ```
92
92
 
93
+ Page and folder entries use names without extensions. A value such as `---Guides---` creates a non-clickable separator label. Read [Configure sidebar navigation](/docs/guides/nested-navigation) to add folder landing pages, deeply nested folders, custom links, and `defaultOpen` behavior.
94
+
93
95
  ## Configure the site
94
96
 
95
97
  Use `geistdocs.tsx` to customize the site shell:
@@ -1,23 +1,184 @@
1
1
  ---
2
- title: Nested navigation
3
- description: How Geistdocs builds breadcrumbs from your page tree.
2
+ title: Configure sidebar navigation
3
+ description: Organize Geistdocs pages with ordered groups, separators, folder indexes, and nested navigation
4
4
  type: guide
5
+ summary: Configure sidebar order, section labels, folder landing pages, and deeply nested page trees with meta.json files.
5
6
  url: /docs/guides/nested-navigation
6
7
  source: apps/template/content/docs/guides/nested-navigation.mdx
8
+ prerequisites:
9
+ - /docs/getting-started
10
+ related:
11
+ - /docs/configuration
12
+ - /docs/syntax
7
13
  ---
8
14
 
9
- # Nested navigation
15
+ # Configure sidebar navigation
10
16
 
11
- Any page nested inside a folder shows a breadcrumb above its title, built
12
- automatically from the page tree. This page lives under the **Guides** folder,
13
- so the breadcrumb above reads _Guides_.
17
+ Use `meta.json` files to organize the Geistdocs sidebar without changing layout components. Each `meta.json` controls the pages and folders in its own directory, so the same pattern works at every nesting level.
14
18
 
15
- ## How it works
19
+ ## Start with the content tree
16
20
 
17
- The breadcrumb lists the folder ancestors of the current page, in order. It is
18
- rendered on the server from the page's URL and the sidebar tree, so it is
19
- present in the initial HTML — the page title never shifts once the page
20
- hydrates.
21
+ Directories become sidebar folders, and `.mdx` files become pages. The examples on this page use the following content tree:
21
22
 
22
- Top-level pages (those not inside a folder) have no ancestors, so no breadcrumb
23
- is shown.
23
+ ```text
24
+ content/docs/
25
+ ├── index.mdx
26
+ ├── getting-started.mdx
27
+ ├── architecture.mdx
28
+ ├── api-reference.mdx
29
+ ├── changelog.mdx
30
+ ├── meta.json
31
+ └── guides/
32
+ ├── index.mdx
33
+ ├── quickstarts.mdx
34
+ ├── meta.json
35
+ └── integrations/
36
+ ├── nextjs.mdx
37
+ ├── sveltekit.mdx
38
+ ├── meta.json
39
+ └── advanced/
40
+ ├── index.mdx
41
+ ├── caching.mdx
42
+ ├── security.mdx
43
+ └── meta.json
44
+ ```
45
+
46
+ Every page needs a frontmatter `title`. Add a `description` to summarize the page. For a regular page, the frontmatter title becomes its sidebar label. Folder landing pages use the folder behavior described below.
47
+
48
+ ## Order top-level pages and add separators
49
+
50
+ Add page and folder names to the root `pages` array without file extensions:
51
+
52
+ ```json title="content/docs/meta.json"
53
+ {
54
+ "title": "My Product Documentation",
55
+ "root": true,
56
+ "pages": [
57
+ "index",
58
+ "getting-started",
59
+ "---Guides---",
60
+ "guides",
61
+ "---Internals---",
62
+ "architecture",
63
+ "api-reference",
64
+ "---Resources---",
65
+ "..."
66
+ ]
67
+ }
68
+ ```
69
+
70
+ This configuration produces three labeled groups after the two introductory pages:
71
+
72
+ - `---Guides---` adds a non-clickable **Guides** separator before the `guides` folder.
73
+ - `---Internals---` adds an **Internals** separator before the architecture and API reference pages.
74
+ - `---Resources---` adds a **Resources** separator before pages inserted by `...`.
75
+
76
+ The `...` entry inserts every page or folder that is not named elsewhere in the array. Place it where the remaining items should appear. Without `...`, unnamed items do not appear in that folder's sidebar navigation.
77
+
78
+ On desktop, top-level folders open as dedicated sidebar sections. On mobile, Geistdocs renders the same page tree as expandable nested navigation. Both layouts use the same `meta.json` files.
79
+
80
+ ## Add a folder landing page
81
+
82
+ Create `index.mdx` inside a nested directory when the folder needs its own landing page:
83
+
84
+ ```mdx title="content/docs/guides/index.mdx"
85
+ ---
86
+ title: Guides
87
+ description: Follow task-focused guides for My Product.
88
+ ---
89
+
90
+ Choose a guide based on the workflow you want to complete.
91
+ ```
92
+
93
+ Then order the folder's child pages in its `meta.json`:
94
+
95
+ ```json title="content/docs/guides/meta.json"
96
+ {
97
+ "title": "Guides",
98
+ "pages": ["quickstarts", "integrations"]
99
+ }
100
+ ```
101
+
102
+ Leave `index` out of a nested folder's `pages` array to use `index.mdx` as the folder landing page. In the desktop section view, Geistdocs exposes a top-level folder index as **Overview**. For a nested folder, the folder label links to its index while the disclosure control expands its children.
103
+
104
+ If you include `index` explicitly in `pages`, Geistdocs treats it as a regular child page instead of the folder landing page.
105
+
106
+ ## Configure deeply nested folders
107
+
108
+ Add another `meta.json` inside each nested directory. For the `integrations` folder from the example tree, group framework pages separately from advanced topics:
109
+
110
+ ```json title="content/docs/guides/integrations/meta.json"
111
+ {
112
+ "title": "Integrations",
113
+ "defaultOpen": true,
114
+ "pages": [
115
+ "---Frameworks---",
116
+ "nextjs",
117
+ "sveltekit",
118
+ "---Advanced---",
119
+ "advanced"
120
+ ]
121
+ }
122
+ ```
123
+
124
+ The `advanced` directory can define another level:
125
+
126
+ ```json title="content/docs/guides/integrations/advanced/meta.json"
127
+ {
128
+ "title": "Advanced Integrations",
129
+ "pages": ["caching", "security"]
130
+ }
131
+ ```
132
+
133
+ Because `advanced/index.mdx` exists and is not listed in `pages`, **Advanced Integrations** links to `/docs/guides/integrations/advanced`. Its child pages resolve to:
134
+
135
+ - `/docs/guides/integrations/advanced/caching`
136
+ - `/docs/guides/integrations/advanced/security`
137
+
138
+ Set `defaultOpen` to `true` when a folder should start expanded. Geistdocs also opens the folders that contain the active page, unless a folder explicitly sets `defaultOpen` to `false`.
139
+
140
+ ## Add a badge to a page
141
+
142
+ Add a short `badge` value to page frontmatter to show status or availability beside its sidebar label:
143
+
144
+ ```yaml title="content/docs/guides/new-api.mdx"
145
+ ---
146
+ title: New API
147
+ description: Use the new API in your application.
148
+ badge: Beta
149
+ ---
150
+ ```
151
+
152
+ Geistdocs renders the badge in desktop and mobile navigation. Badges also appear on folder landing pages because their sidebar items use the folder's `index.mdx` frontmatter. Keep badge text short so the page label has enough room to remain readable.
153
+
154
+ ## Add links to the navigation
155
+
156
+ The `pages` array can include internal and external links alongside content files:
157
+
158
+ ```json title="content/docs/meta.json"
159
+ {
160
+ "pages": [
161
+ "index",
162
+ "[Status](/status)",
163
+ "external:[GitHub](https://github.com/my-org/my-repo)"
164
+ ]
165
+ }
166
+ ```
167
+
168
+ Use `[Label](/path)` for an internal link. Prefix an external link with `external:` so Geistdocs opens it in a new tab and shows the external-link indicator.
169
+
170
+ ## Check breadcrumbs for nested pages
171
+
172
+ Geistdocs builds breadcrumbs from the same page tree. A page at `content/docs/guides/integrations/advanced/caching.mdx` receives the folder path **Guides**, **Integrations**, and **Advanced Integrations** before its page title.
173
+
174
+ Breadcrumbs render on the server from the page URL and sidebar tree, so they are present in the initial HTML. Top-level pages have no folder ancestors and do not render a breadcrumb.
175
+
176
+ ## Troubleshoot missing navigation items
177
+
178
+ Check these rules when a page or folder does not appear where expected:
179
+
180
+ - Match each `pages` entry to a file or directory name without its extension.
181
+ - Add a `meta.json` to every folder that needs custom ordering, separators, `defaultOpen` behavior, or a title override.
182
+ - Add `...` when unlisted files and folders should remain visible.
183
+ - Leave `index` out of a nested folder's `pages` array when it should act as the folder landing page.
184
+ - Keep separator labels between three hyphens on each side, such as `---Internals---`.
@@ -25,10 +25,11 @@ Every MDX file should include frontmatter at the top:
25
25
  ---
26
26
  title: Page Title
27
27
  description: A brief description of the page content
28
+ badge: Beta
28
29
  ---
29
30
  ```
30
31
 
31
- The `title` property is required and is used for the page heading and navigation. The `description` is used for SEO and page previews.
32
+ The `title` property is required and is used for the page heading and navigation. The `description` is used for SEO and page previews. The optional `badge` appears beside the page label in desktop and mobile sidebar navigation.
32
33
 
33
34
  ## Basic Markdown
34
35
 
package/docs/sitemap.md CHANGED
@@ -16,11 +16,11 @@ Use it to choose focused page files from `docs/pages/` before reading the full `
16
16
  - [.md Extension](pages/md.md) | URL: /docs/md | Type: conceptual | Summary: Access any documentation page as raw Markdown by appending .md or .mdx to the URL for AI tool consumption.
17
17
  - [Agent readiness](pages/agent-readiness.md) | URL: /docs/agent-readiness | Type: guide | Summary: Generate /agents.md and /.well-known/mcp.json from Geistdocs config so agents can find docs, Markdown surfaces, API specs, and MCP endpoints.
18
18
  - [Ask AI](pages/ask-ai.md) | URL: /docs/ask-ai | Type: conceptual | Summary: An AI-powered chat assistant with context-aware search, persistent history, and suggested prompts for your documentation.
19
+ - [Configure sidebar navigation](pages/guides/nested-navigation.md) | URL: /docs/guides/nested-navigation | Type: guide | Summary: Configure sidebar order, section labels, folder landing pages, and deeply nested page trees with meta.json files.
19
20
  - [Edit on GitHub](pages/edit-on-github.md) | URL: /docs/edit-on-github | Type: integration | Summary: A direct link on every documentation page that lets readers propose changes through GitHub pull requests.
20
21
  - [Feedback](pages/feedback.md) | URL: /docs/feedback | Type: integration | Summary: An interactive feedback widget that collects user sentiment and creates structured GitHub Issues automatically.
21
22
  - [Internationalization](pages/internationalization.md) | URL: /docs/internationalization | Type: guide | Summary: Serve documentation in multiple languages with automatic translation via the Geistdocs CLI and Fumadocs routing.
22
23
  - [llms.txt](pages/llms-txt.md) | URL: /docs/llms-txt | Type: conceptual | Summary: A single endpoint that returns all documentation as plain Markdown text following the llms.txt standard.
23
- - [Nested navigation](pages/guides/nested-navigation.md) | URL: /docs/guides/nested-navigation | Type: guide
24
24
  - [Open in Chat](pages/open-in-chat.md) | URL: /docs/open-in-chat | Type: conceptual | Summary: Transfer documentation context to AI chat platforms like ChatGPT, Claude, Cursor, and v0 with a single click.
25
25
  - [RSS](pages/rss.md) | URL: /docs/rss | Type: conceptual | Summary: An automatically generated RSS 2.0 feed that keeps users informed when documentation is published or updated.
26
26
  - [Theme-Aware Image](pages/theme-aware-image.md) | URL: /docs/theme-aware-image | Type: reference | Summary: A component that swaps images based on the active theme, built on top of Next.js Image.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@vercel/geistdocs",
3
3
  "description": "Runtime and CLI for Geistdocs projects.",
4
- "version": "1.12.0",
4
+ "version": "1.13.0",
5
5
  "license": "Apache-2.0",
6
6
  "repository": {
7
7
  "type": "git",
package/source-config.js CHANGED
@@ -112,6 +112,7 @@ export const geistShikiTheme = {
112
112
  };
113
113
 
114
114
  export const geistdocsFrontmatterSchema = frontmatterSchema.extend({
115
+ badge: z.string().optional(),
115
116
  product: z.string().optional(),
116
117
  url: z
117
118
  .string()