@vercel/geistdocs 1.2.3-canary.48fea3c → 1.2.3-canary.fd2c9a6

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 (261) hide show
  1. package/dist/assets/icons/icon-arrow-up-right-small.d.ts +8 -0
  2. package/dist/assets/icons/icon-arrow-up-right-small.d.ts.map +1 -0
  3. package/dist/assets/icons/icon-arrow-up-right-small.js +4 -0
  4. package/dist/assets/icons/icon-arrow-up-right.d.ts +5 -0
  5. package/dist/assets/icons/icon-arrow-up-right.d.ts.map +1 -0
  6. package/dist/assets/icons/icon-arrow-up-right.js +4 -0
  7. package/dist/assets/icons/icon-check.d.ts +5 -0
  8. package/dist/assets/icons/icon-check.d.ts.map +1 -0
  9. package/dist/assets/icons/icon-check.js +4 -0
  10. package/dist/assets/icons/icon-chevron-down-small.d.ts +8 -0
  11. package/dist/assets/icons/icon-chevron-down-small.d.ts.map +1 -0
  12. package/dist/assets/icons/icon-chevron-down-small.js +7 -0
  13. package/dist/assets/icons/icon-chevron-right.d.ts +5 -0
  14. package/dist/assets/icons/icon-chevron-right.d.ts.map +1 -0
  15. package/dist/assets/icons/icon-chevron-right.js +4 -0
  16. package/dist/assets/icons/icon-copy.d.ts +5 -0
  17. package/dist/assets/icons/icon-copy.d.ts.map +1 -0
  18. package/dist/assets/icons/icon-copy.js +4 -0
  19. package/dist/assets/icons/icon-file-text.d.ts +5 -0
  20. package/dist/assets/icons/icon-file-text.d.ts.map +1 -0
  21. package/dist/assets/icons/icon-file-text.js +4 -0
  22. package/dist/assets/icons/icon-menu-alt.d.ts +5 -0
  23. package/dist/assets/icons/icon-menu-alt.d.ts.map +1 -0
  24. package/dist/assets/icons/icon-menu-alt.js +4 -0
  25. package/dist/assets/icons/icon-slash-forward.d.ts +8 -0
  26. package/dist/assets/icons/icon-slash-forward.d.ts.map +1 -0
  27. package/dist/assets/icons/icon-slash-forward.js +4 -0
  28. package/dist/assets/icons/index.d.ts +10 -0
  29. package/dist/assets/icons/index.d.ts.map +1 -0
  30. package/{template/components/geistcn-fallbacks/geistcn-assets/icons/index.tsx → dist/assets/icons/index.js} +0 -1
  31. package/dist/assets/logos/index.d.ts +13 -0
  32. package/dist/assets/logos/index.d.ts.map +1 -0
  33. package/{template/components/geistcn-fallbacks/geistcn-assets/logos/index.tsx → dist/assets/logos/index.js} +0 -1
  34. package/dist/assets/logos/logo-ai-elements.d.ts +8 -0
  35. package/dist/assets/logos/logo-ai-elements.d.ts.map +1 -0
  36. package/dist/assets/logos/logo-ai-elements.js +8 -0
  37. package/dist/assets/logos/logo-ai-sdk.d.ts +8 -0
  38. package/dist/assets/logos/logo-ai-sdk.d.ts.map +1 -0
  39. package/dist/assets/logos/logo-ai-sdk.js +8 -0
  40. package/dist/assets/logos/logo-chat-sdk.d.ts +8 -0
  41. package/dist/assets/logos/logo-chat-sdk.d.ts.map +1 -0
  42. package/dist/assets/logos/logo-chat-sdk.js +8 -0
  43. package/dist/assets/logos/logo-flags-sdk.d.ts +8 -0
  44. package/dist/assets/logos/logo-flags-sdk.d.ts.map +1 -0
  45. package/dist/assets/logos/logo-flags-sdk.js +8 -0
  46. package/dist/assets/logos/logo-icon-vercel.d.ts +9 -0
  47. package/dist/assets/logos/logo-icon-vercel.d.ts.map +1 -0
  48. package/dist/assets/logos/logo-icon-vercel.js +8 -0
  49. package/dist/assets/logos/logo-streamdown.d.ts +8 -0
  50. package/dist/assets/logos/logo-streamdown.d.ts.map +1 -0
  51. package/dist/assets/logos/logo-streamdown.js +8 -0
  52. package/dist/assets/logos/logo-vercel-oss.d.ts +8 -0
  53. package/dist/assets/logos/logo-vercel-oss.d.ts.map +1 -0
  54. package/dist/assets/logos/logo-vercel-oss.js +7 -0
  55. package/dist/assets/logos/logo-workflow-sdk.d.ts +8 -0
  56. package/dist/assets/logos/logo-workflow-sdk.d.ts.map +1 -0
  57. package/dist/assets/logos/logo-workflow-sdk.js +8 -0
  58. package/dist/cli/index.js +1 -1
  59. package/dist/components/code-block-tabs.js +3 -3
  60. package/dist/components/code-block.js +3 -3
  61. package/dist/components/copy-prompt.js +3 -3
  62. package/dist/config.d.ts +46 -1
  63. package/dist/config.d.ts.map +1 -1
  64. package/dist/controls.js +4 -4
  65. package/dist/footer.d.ts +8 -0
  66. package/dist/footer.d.ts.map +1 -0
  67. package/dist/footer.js +6 -0
  68. package/dist/home-layout.d.ts +11 -0
  69. package/dist/home-layout.d.ts.map +1 -0
  70. package/dist/home-layout.js +31 -0
  71. package/dist/internal/chat/conversation.js +1 -1
  72. package/dist/internal/chat/message.js +1 -1
  73. package/dist/internal/chat/prompt-input.js +1 -1
  74. package/dist/internal/chat/shell.js +4 -4
  75. package/dist/internal/chat/sources.js +1 -1
  76. package/dist/internal/config-context.d.ts +10 -0
  77. package/dist/internal/config-context.d.ts.map +1 -0
  78. package/dist/internal/config-context.js +15 -0
  79. package/dist/internal/footer/github-button.d.ts +7 -0
  80. package/dist/internal/footer/github-button.d.ts.map +1 -0
  81. package/dist/internal/footer/github-button.js +10 -0
  82. package/dist/internal/footer/rss-button.d.ts +2 -0
  83. package/dist/internal/footer/rss-button.d.ts.map +1 -0
  84. package/dist/internal/footer/rss-button.js +4 -0
  85. package/dist/internal/navbar/desktop-menu.d.ts +10 -0
  86. package/dist/internal/navbar/desktop-menu.d.ts.map +1 -0
  87. package/dist/internal/navbar/desktop-menu.js +11 -0
  88. package/dist/internal/navbar/mobile-menu.d.ts +7 -0
  89. package/dist/internal/navbar/mobile-menu.d.ts.map +1 -0
  90. package/dist/internal/navbar/mobile-menu.js +40 -0
  91. package/dist/internal/navbar/navbar-logo.d.ts +16 -0
  92. package/dist/internal/navbar/navbar-logo.d.ts.map +1 -0
  93. package/dist/internal/navbar/navbar-logo.js +30 -0
  94. package/dist/internal/page-actions-client.d.ts.map +1 -1
  95. package/dist/internal/page-actions-client.js +17 -6
  96. package/dist/internal/page-visibility.d.ts +18 -0
  97. package/dist/internal/page-visibility.d.ts.map +1 -0
  98. package/dist/internal/page-visibility.js +24 -0
  99. package/dist/internal/provider-client.d.ts +1 -1
  100. package/dist/internal/provider-client.d.ts.map +1 -1
  101. package/dist/internal/provider-client.js +2 -1
  102. package/dist/internal/sidebar.js +3 -3
  103. package/dist/internal/ui/button-group.js +2 -2
  104. package/dist/internal/ui/button.d.ts +1 -1
  105. package/dist/internal/ui/button.d.ts.map +1 -1
  106. package/dist/internal/ui/button.js +7 -7
  107. package/dist/internal/ui/card.js +1 -1
  108. package/dist/internal/ui/drawer.js +1 -1
  109. package/dist/internal/ui/dropdown-menu.js +7 -7
  110. package/dist/internal/ui/input-group.js +2 -2
  111. package/dist/internal/ui/input.js +1 -1
  112. package/dist/internal/ui/kbd.js +1 -1
  113. package/dist/internal/ui/navigation-menu.d.ts +17 -0
  114. package/dist/internal/ui/navigation-menu.d.ts.map +1 -0
  115. package/dist/internal/ui/navigation-menu.js +38 -0
  116. package/dist/internal/ui/popover.js +1 -1
  117. package/dist/internal/ui/scroll-area.js +2 -2
  118. package/dist/internal/ui/separator.js +1 -1
  119. package/dist/internal/ui/sheet.js +4 -4
  120. package/dist/internal/ui/sonner.js +3 -3
  121. package/dist/internal/ui/textarea.js +1 -1
  122. package/dist/internal/ui/tooltip.js +1 -1
  123. package/dist/mdx.d.ts +13 -2
  124. package/dist/mdx.d.ts.map +1 -1
  125. package/dist/mdx.js +15 -1
  126. package/dist/mobile-docs-bar.d.ts +7 -0
  127. package/dist/mobile-docs-bar.d.ts.map +1 -0
  128. package/dist/mobile-docs-bar.js +13 -0
  129. package/dist/navbar.d.ts +7 -0
  130. package/dist/navbar.d.ts.map +1 -0
  131. package/dist/navbar.js +10 -0
  132. package/dist/pages/docs.d.ts +2 -1
  133. package/dist/pages/docs.d.ts.map +1 -1
  134. package/dist/pages/docs.js +8 -3
  135. package/dist/proxy.d.ts +1 -1
  136. package/dist/proxy.d.ts.map +1 -1
  137. package/dist/proxy.js +28 -2
  138. package/dist/routes/agents.d.ts +21 -0
  139. package/dist/routes/agents.d.ts.map +1 -0
  140. package/dist/routes/agents.js +201 -0
  141. package/dist/routes/chat.d.ts.map +1 -1
  142. package/dist/routes/chat.js +12 -3
  143. package/dist/routes/llms.d.ts +6 -5
  144. package/dist/routes/llms.d.ts.map +1 -1
  145. package/dist/routes/llms.js +63 -12
  146. package/dist/routes/search.d.ts +6 -4
  147. package/dist/routes/search.d.ts.map +1 -1
  148. package/dist/routes/search.js +8 -1
  149. package/dist/routes/sitemap.d.ts +6 -3
  150. package/dist/routes/sitemap.d.ts.map +1 -1
  151. package/dist/routes/sitemap.js +10 -2
  152. package/dist/shiki-theme.d.ts +20 -0
  153. package/dist/shiki-theme.d.ts.map +1 -0
  154. package/dist/shiki-theme.js +110 -0
  155. package/dist/source.d.ts +8 -1
  156. package/dist/source.d.ts.map +1 -1
  157. package/dist/source.js +14 -1
  158. package/dist/versions.d.ts.map +1 -1
  159. package/dist/versions.js +34 -16
  160. package/package.json +43 -3
  161. package/styles.css +465 -102
  162. package/template/AGENTS.md +69 -0
  163. package/template/app/[lang]/(home)/components/centered-section.tsx +1 -3
  164. package/template/app/[lang]/(home)/components/hero.tsx +2 -2
  165. package/template/app/[lang]/(home)/components/one-two-section.tsx +1 -3
  166. package/template/app/[lang]/(home)/components/templates.tsx +3 -5
  167. package/template/app/[lang]/(home)/components/text-grid-section.tsx +1 -1
  168. package/template/app/[lang]/(home)/layout.tsx +4 -3
  169. package/template/app/[lang]/(home)/page.tsx +2 -2
  170. package/template/app/[lang]/agents.md/route.ts +6 -0
  171. package/template/app/[lang]/docs/[[...slug]]/page.tsx +1 -1
  172. package/template/app/[lang]/layout.tsx +6 -6
  173. package/template/app/[lang]/llms.mdx/[[...slug]]/route.ts +1 -1
  174. package/template/app/[lang]/sitemap.md/route.ts +2 -2
  175. package/template/app/api/search/route.ts +2 -2
  176. package/template/app/styles/geistdocs.css +150 -109
  177. package/template/components/ui/badge.tsx +5 -5
  178. package/template/components/ui/button.tsx +7 -7
  179. package/template/components/ui/command-prompt.tsx +2 -2
  180. package/template/content/docs/agent-readiness.mdx +103 -0
  181. package/template/content/docs/configuration.mdx +40 -1
  182. package/template/content/docs/index.mdx +1 -0
  183. package/template/content/docs/llms-txt.mdx +1 -0
  184. package/template/content/docs/md.mdx +2 -1
  185. package/template/content/docs/meta.json +1 -0
  186. package/template/content/docs/proxy.mdx +10 -1
  187. package/template/content/docs/theme-aware-image.mdx +1 -1
  188. package/template/geistdocs.tsx +26 -0
  189. package/template/lib/geistdocs/config.tsx +3 -0
  190. package/template/package.json +3 -3
  191. package/template/proxy.ts +0 -1
  192. package/template/source.config.ts +125 -0
  193. package/template/app/actions/feedback/emotions.ts +0 -18
  194. package/template/app/actions/feedback/index.ts +0 -45
  195. package/template/components/geistcn-fallbacks/geistcn-assets/icons/icon-arrow-up-right-small.tsx +0 -35
  196. package/template/components/geistcn-fallbacks/geistcn-assets/icons/icon-arrow-up-right.tsx +0 -27
  197. package/template/components/geistcn-fallbacks/geistcn-assets/icons/icon-check.tsx +0 -27
  198. package/template/components/geistcn-fallbacks/geistcn-assets/icons/icon-chevron-down-small.tsx +0 -30
  199. package/template/components/geistcn-fallbacks/geistcn-assets/icons/icon-chevron-right.tsx +0 -27
  200. package/template/components/geistcn-fallbacks/geistcn-assets/icons/icon-copy.tsx +0 -27
  201. package/template/components/geistcn-fallbacks/geistcn-assets/icons/icon-file-text.tsx +0 -25
  202. package/template/components/geistcn-fallbacks/geistcn-assets/icons/icon-menu-alt.tsx +0 -27
  203. package/template/components/geistcn-fallbacks/geistcn-assets/icons/icon-slash-forward.tsx +0 -36
  204. package/template/components/geistcn-fallbacks/geistcn-assets/logos/logo-ai-elements.tsx +0 -29
  205. package/template/components/geistcn-fallbacks/geistcn-assets/logos/logo-ai-sdk.tsx +0 -38
  206. package/template/components/geistcn-fallbacks/geistcn-assets/logos/logo-chat-sdk.tsx +0 -42
  207. package/template/components/geistcn-fallbacks/geistcn-assets/logos/logo-flags-sdk.tsx +0 -42
  208. package/template/components/geistcn-fallbacks/geistcn-assets/logos/logo-icon-vercel.tsx +0 -31
  209. package/template/components/geistcn-fallbacks/geistcn-assets/logos/logo-streamdown.tsx +0 -29
  210. package/template/components/geistcn-fallbacks/geistcn-assets/logos/logo-vercel-oss.tsx +0 -24
  211. package/template/components/geistcn-fallbacks/geistcn-assets/logos/logo-workflow-sdk.tsx +0 -73
  212. package/template/components/geistdocs/callout.tsx +0 -40
  213. package/template/components/geistdocs/chat.tsx +0 -24
  214. package/template/components/geistdocs/code-block-tabs.tsx +0 -61
  215. package/template/components/geistdocs/code-block.tsx +0 -134
  216. package/template/components/geistdocs/copy-page.tsx +0 -27
  217. package/template/components/geistdocs/desktop-menu.tsx +0 -52
  218. package/template/components/geistdocs/docs-page.tsx +0 -35
  219. package/template/components/geistdocs/edit-source.tsx +0 -30
  220. package/template/components/geistdocs/feedback.tsx +0 -139
  221. package/template/components/geistdocs/footer.tsx +0 -30
  222. package/template/components/geistdocs/github-button.tsx +0 -19
  223. package/template/components/geistdocs/home-layout.tsx +0 -46
  224. package/template/components/geistdocs/icons.tsx +0 -13
  225. package/template/components/geistdocs/installer.tsx +0 -58
  226. package/template/components/geistdocs/language-selector.tsx +0 -3
  227. package/template/components/geistdocs/mermaid.tsx +0 -68
  228. package/template/components/geistdocs/mobile-docs-bar.tsx +0 -77
  229. package/template/components/geistdocs/mobile-menu.tsx +0 -150
  230. package/template/components/geistdocs/navbar-logo.tsx +0 -124
  231. package/template/components/geistdocs/navbar.tsx +0 -22
  232. package/template/components/geistdocs/rss-button.tsx +0 -10
  233. package/template/components/geistdocs/scroll-top.tsx +0 -21
  234. package/template/components/geistdocs/search.tsx +0 -17
  235. package/template/components/geistdocs/sidebar.tsx +0 -128
  236. package/template/components/geistdocs/theme-aware-image.tsx +0 -22
  237. package/template/components/geistdocs/theme-toggle.tsx +0 -3
  238. package/template/components/geistdocs/video.tsx +0 -16
  239. package/template/components/ui/button-group.tsx +0 -83
  240. package/template/components/ui/card.tsx +0 -92
  241. package/template/components/ui/collapsible.tsx +0 -33
  242. package/template/components/ui/command.tsx +0 -184
  243. package/template/components/ui/dialog.tsx +0 -143
  244. package/template/components/ui/drawer.tsx +0 -135
  245. package/template/components/ui/dropdown-menu.tsx +0 -257
  246. package/template/components/ui/hover-card.tsx +0 -44
  247. package/template/components/ui/input-group.tsx +0 -170
  248. package/template/components/ui/input.tsx +0 -21
  249. package/template/components/ui/kbd.tsx +0 -28
  250. package/template/components/ui/navigation-menu.tsx +0 -192
  251. package/template/components/ui/popover.tsx +0 -48
  252. package/template/components/ui/scroll-area.tsx +0 -58
  253. package/template/components/ui/select.tsx +0 -187
  254. package/template/components/ui/separator.tsx +0 -28
  255. package/template/components/ui/sheet.tsx +0 -139
  256. package/template/components/ui/sonner.tsx +0 -40
  257. package/template/components/ui/spinner.tsx +0 -16
  258. package/template/components/ui/textarea.tsx +0 -18
  259. package/template/components/ui/tooltip.tsx +0 -61
  260. package/template/hooks/geistdocs/use-sidebar.ts +0 -13
  261. package/template/hooks/use-mobile.ts +0 -19
@@ -0,0 +1,103 @@
1
+ ---
2
+ title: Agent readiness
3
+ description: Expose a concise agents.md file that helps AI agents discover and use your docs site
4
+ type: guide
5
+ summary: Generate /agents.md from Geistdocs config so agents can find docs, Markdown surfaces, API specs, and MCP endpoints.
6
+ related:
7
+ - /docs/llms-txt
8
+ - /docs/md
9
+ - /docs/proxy
10
+ ---
11
+
12
+ Geistdocs can generate `/agents.md`, a concise Markdown file that tells AI agents what your product is, where your docs live, and which machine-readable integration surfaces are available.
13
+
14
+ <CopyPrompt text="Review this Geistdocs site's /agents.md file. Check whether it lists the product description, documentation links, llms.txt, sitemap.md, OpenAPI specs, and MCP servers accurately.">
15
+ Review this Geistdocs site's `/agents.md` file. Check whether it lists the product description, documentation links, `llms.txt`, `sitemap.md`, OpenAPI specs, and MCP servers accurately.
16
+ </CopyPrompt>
17
+
18
+ ## What it provides
19
+
20
+ The generated `/agents.md` file gives agents a stable starting point before they crawl the rest of your documentation.
21
+
22
+ It can include:
23
+
24
+ - Product name, description, category, audience, and use cases
25
+ - Human-readable docs entry points
26
+ - `/llms.txt` for full documentation context
27
+ - `/sitemap.md` for semantic navigation
28
+ - Page-level Markdown guidance for `.md` and `.mdx` URLs
29
+ - OpenAPI, authentication, scopes, rate limit, and error docs when configured
30
+ - MCP manifests and server URLs when configured
31
+ - Additional links and agent instructions
32
+
33
+ ## Add the route
34
+
35
+ Generated projects include a thin App Router adapter:
36
+
37
+ ```ts title="app/[lang]/agents.md/route.ts"
38
+ import { createAgentsRoute } from "@vercel/geistdocs/routes/agents";
39
+ import { config } from "@/lib/geistdocs/config";
40
+
41
+ export const { GET, generateStaticParams, revalidate } = createAgentsRoute({
42
+ config,
43
+ });
44
+ ```
45
+
46
+ Because the route is under `[lang]`, the Geistdocs proxy can serve `/agents.md` through the default language route.
47
+
48
+ ## Configure agent metadata
49
+
50
+ Add agent-readiness metadata in `geistdocs.tsx`, then pass it through `defineConfig` in `lib/geistdocs/config.tsx`.
51
+
52
+ ```tsx title="geistdocs.tsx"
53
+ import type { GeistdocsAgentReadinessConfig } from "@vercel/geistdocs/config";
54
+
55
+ export const agent = {
56
+ product: {
57
+ name: "My Product",
58
+ description: "My Product helps teams build and deploy applications.",
59
+ category: "Developer tools",
60
+ audience: ["Frontend developers", "Platform teams"],
61
+ useCases: ["Deploy applications", "Manage domains", "Inspect logs"],
62
+ },
63
+ api: {
64
+ openApiUrl: "https://api.example.com/openapi.json",
65
+ authDocsUrl: "/docs/authentication",
66
+ scopesDocsUrl: "/docs/scopes",
67
+ rateLimitsUrl: "/docs/rate-limits",
68
+ errorsUrl: "/docs/errors",
69
+ },
70
+ mcp: {
71
+ manifestUrl: "/.well-known/mcp.json",
72
+ servers: [
73
+ {
74
+ name: "My Product MCP",
75
+ url: "https://example.com/api/mcp",
76
+ description: "Use product tools through MCP.",
77
+ },
78
+ ],
79
+ },
80
+ links: [
81
+ {
82
+ label: "Support",
83
+ href: "https://example.com/support",
84
+ description: "Get help from the product team.",
85
+ },
86
+ ],
87
+ } satisfies GeistdocsAgentReadinessConfig;
88
+ ```
89
+
90
+ ```tsx title="lib/geistdocs/config.tsx"
91
+ import { agent } from "@/geistdocs";
92
+
93
+ export const config = defineConfig({
94
+ // ...
95
+ agent,
96
+ });
97
+ ```
98
+
99
+ ## Keep it honest
100
+
101
+ Only list OpenAPI specs, authentication flows, or MCP servers that actually exist. Geistdocs makes product capabilities discoverable, but it does not create APIs or MCP tools for you.
102
+
103
+ Use `/agents.md` with [llms.txt](/docs/llms-txt), [.md extension](/docs/md), and [Proxy and markdown routes](/docs/proxy) to give agents a complete discovery path.
@@ -22,12 +22,13 @@ Configure Geistdocs through user-owned files in the generated project. Runtime f
22
22
 
23
23
  | File | Purpose |
24
24
  | --- | --- |
25
- | `geistdocs.tsx` | Site-level settings, including logo, nav, GitHub repo, AI prompt, translations, and feature flags. |
25
+ | `geistdocs.tsx` | Site-level settings, including logo, nav, GitHub repo, AI prompt, agent-readiness metadata, translations, and feature flags. |
26
26
  | `lib/geistdocs/config.tsx` | Converts `geistdocs.tsx` exports into the package config using `defineConfig`. |
27
27
  | `lib/geistdocs/source.ts` | Connects Fumadocs content collections to the package source adapter. |
28
28
  | `components/geistdocs/mdx-components.tsx` | Adds or overrides MDX components. |
29
29
  | `components/geistdocs/docs-layout.tsx` | Customizes the package-backed docs layout, including optional sidebar content. |
30
30
  | `app/[lang]/docs/[[...slug]]/page.tsx` | Configures the package docs page renderer. |
31
+ | `app/[lang]/agents.md/route.ts` | Configures the agent-readiness entry point. |
31
32
  | `app/[lang]/llms.txt/route.ts` | Configures the all-docs Markdown endpoint. |
32
33
  | `app/[lang]/llms.mdx/[[...slug]]/route.ts` | Configures single-page Markdown responses. |
33
34
  | `proxy.ts` | Configures markdown negotiation, AI-agent rewrites, request tracking, and custom request hooks. |
@@ -43,6 +44,8 @@ export const Logo = () => <span>My Docs</span>;
43
44
  export const github = {
44
45
  owner: "my-org",
45
46
  repo: "my-repo",
47
+ branch: "main",
48
+ editPath: "content/docs/{path}",
46
49
  };
47
50
 
48
51
  export const nav = [
@@ -60,6 +63,13 @@ export const suggestions = [
60
63
  "How do I deploy?",
61
64
  ];
62
65
 
66
+ export const agent = {
67
+ product: {
68
+ name: "My Product",
69
+ description: "My Product helps teams build and deploy applications.",
70
+ },
71
+ };
72
+
63
73
  export const translations = {
64
74
  en: { displayName: "English" },
65
75
  };
@@ -75,6 +85,7 @@ export const siteId: string | undefined = undefined;
75
85
  ```tsx title="lib/geistdocs/config.tsx"
76
86
  import { defineConfig } from "@vercel/geistdocs/config";
77
87
  import {
88
+ agent,
78
89
  basePath,
79
90
  github,
80
91
  Logo,
@@ -88,6 +99,7 @@ import {
88
99
 
89
100
  export const config = defineConfig({
90
101
  title,
102
+ agent,
91
103
  defaultLanguage: "en",
92
104
  logo: <Logo />,
93
105
  github,
@@ -148,6 +160,33 @@ export const config = defineConfig({
148
160
  });
149
161
  ```
150
162
 
163
+ `github.editPath` controls the file path used by the "Edit this page on GitHub" action. Use `{path}` where the page path should be inserted. For monorepos, include the app directory, such as `apps/docs/content/docs/{path}`.
164
+
165
+ ## Page visibility
166
+
167
+ Use frontmatter to control whether a page appears in package-owned machine-readable surfaces:
168
+
169
+ ```mdx title="content/docs/internal-note.mdx"
170
+ ---
171
+ title: Internal note
172
+ description: Hidden from public indexes
173
+ internal: true
174
+ ---
175
+ ```
176
+
177
+ `internal: true` excludes a page from `llms.txt`, `sitemap.md`, search, and chat. `noindex: true` adds `robots: noindex` metadata and excludes the page from `sitemap.md`. Use `excludeFrom` for per-surface control:
178
+
179
+ ```mdx
180
+ ---
181
+ title: Draft guide
182
+ excludeFrom:
183
+ - chat
184
+ - search
185
+ ---
186
+ ```
187
+
188
+ Optional `tags`, `keywords`, and `canonical` frontmatter are also recognized by the package runtime.
189
+
151
190
  ## User-owned adapters
152
191
 
153
192
  Adapter files are safe to edit. Package updates do not overwrite them.
@@ -74,6 +74,7 @@ Advanced projects can use package APIs for versioned docs, multiple content sour
74
74
  - Local content in `content/docs`
75
75
  - Search and Ask AI
76
76
  - Page actions, including feedback, copy page, open in chat, and edit on GitHub
77
+ - Agent-readiness metadata with `/agents.md`
77
78
  - Raw Markdown routes for AI tools
78
79
  - `llms.txt`
79
80
  - Versioned docs and multiple content sources
@@ -4,6 +4,7 @@ description: A single file containing all your documentation in plain text for A
4
4
  type: conceptual
5
5
  summary: A single endpoint that returns all documentation as plain Markdown text following the llms.txt standard.
6
6
  related:
7
+ - /docs/agent-readiness
7
8
  - /docs/md
8
9
  - /docs/ask-ai
9
10
  - /docs/proxy
@@ -4,6 +4,7 @@ description: Access documentation pages as raw Markdown by appending .md or .mdx
4
4
  type: conceptual
5
5
  summary: Access any documentation page as raw Markdown by appending .md or .mdx to the URL for AI tool consumption.
6
6
  related:
7
+ - /docs/agent-readiness
7
8
  - /docs/llms-txt
8
9
  - /docs/proxy
9
10
  ---
@@ -64,7 +65,7 @@ import { geistdocsSource } from "@/lib/geistdocs/source";
64
65
 
65
66
  export const { GET, generateStaticParams, revalidate } =
66
67
  createDocsMarkdownRoute({
67
- source: geistdocsSource,
68
+ sources: [geistdocsSource],
68
69
  });
69
70
  ```
70
71
 
@@ -17,6 +17,7 @@
17
17
  "...",
18
18
  "---AI---",
19
19
  "open-in-chat",
20
+ "agent-readiness",
20
21
  "llms-txt",
21
22
  "ask-ai"
22
23
  ]
@@ -84,7 +84,16 @@ const proxy = createProxy({
84
84
 
85
85
  ## Markdown route mappings
86
86
 
87
- `markdownRoutes` maps public page URLs to the App Router handlers that return Markdown. The package still serves `/llms.txt` and individual page Markdown through route helpers; the proxy uses these mappings for `.md`, `.mdx`, `Accept: text/markdown`, and AI-agent requests.
87
+ Define `content` sections in `lib/geistdocs/config.tsx` to infer standard Markdown route mappings from each section route. The package still serves `/llms.txt` and individual page Markdown through route helpers; the proxy uses these mappings for `.md`, `.mdx`, `Accept: text/markdown`, and AI-agent requests.
88
+
89
+ ```tsx title="lib/geistdocs/config.tsx"
90
+ export const config = defineConfig({
91
+ // ...
92
+ content: [{ id: "docs", label: "Docs", dir: "content/docs", route: "/docs" }],
93
+ });
94
+ ```
95
+
96
+ Use `markdownRoutes` when you need to override the inferred mappings:
88
97
 
89
98
  ```ts title="proxy.ts"
90
99
  const proxy = createProxy({
@@ -22,7 +22,7 @@ The `ThemeAwareImage` component renders different images depending on whether th
22
22
  Import the component and pass a `src` object with `light` and `dark` variants:
23
23
 
24
24
  ```tsx
25
- import { ThemeAwareImage } from "@/components/geistdocs/theme-aware-image";
25
+ import { ThemeAwareImage } from "@vercel/geistdocs/components/theme-aware-image";
26
26
 
27
27
  <ThemeAwareImage
28
28
  src={{
@@ -1,3 +1,5 @@
1
+ import type { GeistdocsAgentReadinessConfig } from "@vercel/geistdocs/config";
2
+
1
3
  export const Logo = () => (
2
4
  <span className="font-semibold text-gray-1000 text-lg leading-none tracking-[-3%]">
3
5
  Geistdocs
@@ -5,6 +7,8 @@ export const Logo = () => (
5
7
  );
6
8
 
7
9
  export const github = {
10
+ branch: "main",
11
+ editPath: "content/docs/{path}",
8
12
  owner: "vercel",
9
13
  repo: "geistdocs",
10
14
  };
@@ -32,6 +36,28 @@ export const title = "Geistdocs Documentation";
32
36
  export const prompt =
33
37
  "You are a helpful assistant specializing in answering questions about Geistdocs, a modern documentation template built with Next.js and Fumadocs.";
34
38
 
39
+ export const agent = {
40
+ product: {
41
+ name: "Geistdocs",
42
+ description:
43
+ "Geistdocs is a package-backed documentation system for creating Next.js and Fumadocs sites with shared Vercel documentation patterns.",
44
+ category: "Documentation",
45
+ audience: ["Documentation authors", "Developer experience teams"],
46
+ useCases: [
47
+ "Create package-backed documentation sites",
48
+ "Expose docs as AI-readable Markdown",
49
+ "Share Vercel docs UI and runtime behavior across projects",
50
+ ],
51
+ },
52
+ links: [
53
+ {
54
+ label: "Geistdocs source",
55
+ href: `https://github.com/${github.owner}/${github.repo}`,
56
+ description: "Source repository for the Geistdocs package and template",
57
+ },
58
+ ],
59
+ } satisfies GeistdocsAgentReadinessConfig;
60
+
35
61
  export const translations = {
36
62
  en: {
37
63
  displayName: "English",
@@ -1,5 +1,6 @@
1
1
  import { defineConfig } from "@vercel/geistdocs/config";
2
2
  import {
3
+ agent,
3
4
  basePath,
4
5
  github,
5
6
  Logo,
@@ -13,6 +14,7 @@ import {
13
14
 
14
15
  export const config = defineConfig({
15
16
  title,
17
+ agent,
16
18
  defaultLanguage: "en",
17
19
  logo: <Logo />,
18
20
  github,
@@ -20,6 +22,7 @@ export const config = defineConfig({
20
22
  basePath,
21
23
  siteId,
22
24
  translations,
25
+ content: [{ id: "docs", label: "Docs", dir: "content/docs", route: "/docs" }],
23
26
  ai: {
24
27
  prompt,
25
28
  suggestions,
@@ -14,7 +14,7 @@
14
14
  "@ai-sdk/react": "^2.0.115",
15
15
  "@icons-pack/react-simple-icons": "^13.8.0",
16
16
  "@orama/tokenizers": "^3.1.16",
17
- "@vercel/geistdocs": "1.2.3-canary.48fea3c",
17
+ "@vercel/geistdocs": "1.2.3-canary.fd2c9a6",
18
18
  "@streamdown/cjk": "^1.0.1",
19
19
  "@streamdown/code": "^1.0.1",
20
20
  "@vercel/agent-readability": "^0.2.1",
@@ -35,13 +35,13 @@
35
35
  "mermaid": "^11.12.2",
36
36
  "motion": "^12.23.25",
37
37
  "nanoid": "^5.1.6",
38
- "next": "16.0.10",
38
+ "next": "16.2.6",
39
39
  "next-themes": "^0.4.6",
40
40
  "radix-ui": "latest",
41
41
  "react": "^19.2.3",
42
42
  "react-dom": "^19.2.3",
43
43
  "react-player": "^3.4.0",
44
- "shiki": "^3.22.0",
44
+ "shiki": "3.19.0",
45
45
  "sonner": "^2.0.7",
46
46
  "streamdown": "^2.1.0",
47
47
  "tailwind-merge": "^3.4.0",
package/template/proxy.ts CHANGED
@@ -5,7 +5,6 @@ import { trackMdRequest } from "@/lib/geistdocs/md-tracking";
5
5
  const proxy = createProxy({
6
6
  config: geistdocsConfig,
7
7
  trackMarkdownRequest: trackMdRequest,
8
- markdownRoutes: [{ from: "/docs/*path", to: "/[lang]/llms.mdx/*path" }],
9
8
  before: () => null,
10
9
  });
11
10
 
@@ -8,6 +8,119 @@ import {
8
8
  import lastModified from "fumadocs-mdx/plugins/last-modified";
9
9
  import { z } from "zod";
10
10
 
11
+ // Shiki css-variables theme inlined here (not imported from
12
+ // @vercel/geistdocs/shiki-theme) because fumadocs-mdx evaluates this file
13
+ // during `pnpm install`, before workspace packages are built. The same theme
14
+ // is also exported from @vercel/geistdocs/shiki-theme for runtime consumers.
15
+ // CSS variables are wired in geistdocs.css under :root.
16
+ const geistShikiTheme = {
17
+ name: "geist",
18
+ type: "dark" as const,
19
+ colors: {
20
+ "editor.foreground": "var(--shiki-color-text, inherit)",
21
+ "editor.background": "var(--shiki-color-background, transparent)",
22
+ },
23
+ tokenColors: [
24
+ {
25
+ scope: ["comment", "punctuation.definition.comment", "string.comment"],
26
+ settings: { foreground: "var(--shiki-token-comment)" },
27
+ },
28
+ {
29
+ scope: [
30
+ "constant",
31
+ "entity.name.constant",
32
+ "variable.other.constant",
33
+ "variable.other.enummember",
34
+ "variable.language",
35
+ "entity",
36
+ ],
37
+ settings: { foreground: "var(--shiki-token-constant)" },
38
+ },
39
+ {
40
+ scope: ["entity.name", "meta.export.default", "meta.definition.variable"],
41
+ settings: { foreground: "var(--shiki-token-function)" },
42
+ },
43
+ {
44
+ scope: [
45
+ "variable.parameter.function",
46
+ "meta.jsx.children",
47
+ "meta.block",
48
+ "meta.tag.attributes",
49
+ "entity.name.section",
50
+ "text",
51
+ "punctuation.definition.tag",
52
+ "punctuation.separator.inheritance.php",
53
+ "punctuation.definition.tag.html",
54
+ "punctuation.definition.tag.begin.html",
55
+ "punctuation.definition.tag.end.html",
56
+ "punctuation.section.embedded",
57
+ "variable.parameter",
58
+ ],
59
+ settings: { foreground: "var(--shiki-token-parameter)" },
60
+ },
61
+ {
62
+ scope: ["entity.name.tag", "support.class.component"],
63
+ settings: { foreground: "var(--shiki-token-function)" },
64
+ },
65
+ {
66
+ scope: "keyword",
67
+ settings: { foreground: "var(--shiki-token-keyword)" },
68
+ },
69
+ {
70
+ scope: ["storage", "storage.type", "storage.modifier"],
71
+ settings: { foreground: "var(--shiki-token-keyword)" },
72
+ },
73
+ {
74
+ scope: [
75
+ "string",
76
+ "string punctuation.section.embedded source",
77
+ "attribute.value",
78
+ ],
79
+ settings: { foreground: "var(--shiki-token-string)" },
80
+ },
81
+ {
82
+ scope: [
83
+ "punctuation",
84
+ "punctuation.definition.string",
85
+ "punctuation.definition.variable",
86
+ "punctuation.definition.string.begin",
87
+ "punctuation.definition.string.end",
88
+ "punctuation.section.embedded.begin",
89
+ "punctuation.section.embedded.end",
90
+ ],
91
+ settings: { foreground: "var(--shiki-token-punctuation)" },
92
+ },
93
+ {
94
+ scope: "string.regexp",
95
+ settings: { foreground: "var(--shiki-token-string-expression)" },
96
+ },
97
+ {
98
+ scope: [
99
+ "support.function",
100
+ "entity.name.function",
101
+ "meta.function-call.generic",
102
+ ],
103
+ settings: { foreground: "var(--shiki-token-function)" },
104
+ },
105
+ {
106
+ scope: "markup.underline.link",
107
+ settings: { foreground: "var(--shiki-token-link)" },
108
+ },
109
+ {
110
+ // Markdown list/task content. Shiki's markdown grammar tokenizes
111
+ // bracketed text (including the "x" in "[x]" task markers) as
112
+ // `string.other.link.title.markdown`; pin those to the surrounding
113
+ // list-item color so markdown blocks look uniform.
114
+ scope: [
115
+ "markup.list",
116
+ "string.other.link.title.markdown",
117
+ "string.other.link.description.markdown",
118
+ ],
119
+ settings: { foreground: "var(--shiki-token-parameter)" },
120
+ },
121
+ ],
122
+ };
123
+
11
124
  // You can customise Zod schemas for frontmatter and `meta.json` here
12
125
  // see https://fumadocs.dev/docs/mdx/collections
13
126
  export const docs = defineDocs({
@@ -44,6 +157,14 @@ export const docs = defineDocs({
44
157
  )
45
158
  .optional(),
46
159
  summary: z.string().optional(),
160
+ internal: z.boolean().optional(),
161
+ noindex: z.boolean().optional(),
162
+ tags: z.array(z.string()).optional(),
163
+ keywords: z.array(z.string()).optional(),
164
+ canonical: z.string().optional(),
165
+ excludeFrom: z
166
+ .array(z.enum(["chat", "llms", "search", "sitemap"]))
167
+ .optional(),
47
168
  }),
48
169
  postprocess: {
49
170
  includeProcessedMarkdown: true,
@@ -57,6 +178,10 @@ export const docs = defineDocs({
57
178
  export default defineConfig({
58
179
  mdxOptions: {
59
180
  remarkPlugins: [remarkMdxMermaid],
181
+ rehypeCodeOptions: {
182
+ themes: { light: geistShikiTheme, dark: geistShikiTheme },
183
+ defaultColor: "light",
184
+ },
60
185
  },
61
186
  plugins: [lastModified()],
62
187
  });
@@ -1,18 +0,0 @@
1
- export const emotions = [
2
- {
3
- name: "cry",
4
- emoji: "😭",
5
- },
6
- {
7
- name: "sad",
8
- emoji: "😕",
9
- },
10
- {
11
- name: "happy",
12
- emoji: "🙂",
13
- },
14
- {
15
- name: "amazed",
16
- emoji: "🤩",
17
- },
18
- ];
@@ -1,45 +0,0 @@
1
- "use server";
2
-
3
- import { headers } from "next/headers";
4
- import type { Feedback } from "@/components/geistdocs/feedback";
5
- import { siteId } from "@/geistdocs";
6
- import { emotions } from "./emotions";
7
-
8
- const protocol = process.env.NODE_ENV === "production" ? "https" : "http";
9
- const baseUrl = `${protocol}://${process.env.NEXT_PUBLIC_VERCEL_PROJECT_PRODUCTION_URL}`;
10
-
11
- export const sendFeedback = async (
12
- url: string,
13
- feedback: Feedback
14
- ): Promise<{ success: boolean }> => {
15
- const emoji = emotions.find((e) => e.name === feedback.emotion)?.emoji;
16
- const endpoint = new URL("/feedback", "https://geistdocs.com/feedback");
17
- const headersList = await headers();
18
-
19
- const response = await fetch(endpoint, {
20
- method: "POST",
21
- headers: {
22
- "Content-Type": "application/json",
23
- },
24
- body: JSON.stringify({
25
- note: feedback.message,
26
- url: new URL(url, baseUrl).toString(),
27
- emotion: emoji,
28
- ua: headersList.get("user-agent") ?? undefined,
29
- ip: headersList.get("x-real-ip") || headersList.get("x-forwarded-for"),
30
- label: siteId,
31
- }),
32
- });
33
-
34
- if (!response.ok) {
35
- const error = await response.json();
36
-
37
- console.error(error);
38
-
39
- return { success: false };
40
- }
41
-
42
- return {
43
- success: true,
44
- };
45
- };
@@ -1,35 +0,0 @@
1
- import type { SVGProps } from "react";
2
-
3
- interface IconProps
4
- extends Omit<
5
- SVGProps<SVGSVGElement>,
6
- "width" | "height" | "viewBox" | "fill"
7
- > {
8
- color?: string;
9
- size?: number | string;
10
- }
11
-
12
- export function IconArrowUpRightSmall({
13
- size = 16,
14
- color = "currentColor",
15
- ...props
16
- }: IconProps) {
17
- return (
18
- <svg
19
- aria-hidden="true"
20
- fill="none"
21
- height={size}
22
- role="img"
23
- viewBox="0 0 16 16"
24
- width={size}
25
- {...props}
26
- >
27
- <path
28
- clipRule="evenodd"
29
- d="M6.75 4H6v1.5h3.44L5.47 9.47l-.53.53L6 11.06l.53-.53 3.97-3.97V10H12V5a1 1 0 0 0-1-1z"
30
- fill={color}
31
- fillRule="evenodd"
32
- />
33
- </svg>
34
- );
35
- }
@@ -1,27 +0,0 @@
1
- export function IconArrowUpRight({
2
- size = 16,
3
- className,
4
- }: {
5
- size?: number;
6
- className?: string;
7
- }) {
8
- return (
9
- <svg
10
- aria-hidden="true"
11
- className={className}
12
- fill="none"
13
- height={size}
14
- role="img"
15
- viewBox="0 0 16 16"
16
- width={size}
17
- xmlns="http://www.w3.org/2000/svg"
18
- >
19
- <path
20
- clipRule="evenodd"
21
- d="M5.75001 2H5.00001V3.5H5.75001H11.4393L2.21968 12.7197L1.68935 13.25L2.75001 14.3107L3.28034 13.7803L12.4988 4.56182V10.25V11H13.9988V10.25V3C13.9988 2.44772 13.5511 2 12.9988 2H5.75001Z"
22
- fill="currentColor"
23
- fillRule="evenodd"
24
- />
25
- </svg>
26
- );
27
- }
@@ -1,27 +0,0 @@
1
- export function IconCheck({
2
- size = 16,
3
- className,
4
- }: {
5
- size?: number;
6
- className?: string;
7
- }) {
8
- return (
9
- <svg
10
- aria-hidden="true"
11
- className={className}
12
- fill="none"
13
- height={size}
14
- role="img"
15
- viewBox="0 0 16 16"
16
- width={size}
17
- xmlns="http://www.w3.org/2000/svg"
18
- >
19
- <path
20
- clipRule="evenodd"
21
- d="M15.5607 3.99999L15.0303 4.53032L6.23744 13.3232C5.55403 14.0066 4.44599 14.0066 3.76257 13.3232L4.2929 12.7929L3.76257 13.3232L0.969676 10.5303L0.439346 9.99999L1.50001 8.93933L2.03034 9.46966L4.82323 12.2626C4.92086 12.3602 5.07915 12.3602 5.17678 12.2626L13.9697 3.46966L14.5 2.93933L15.5607 3.99999Z"
22
- fill="currentColor"
23
- fillRule="evenodd"
24
- />
25
- </svg>
26
- );
27
- }