@vercel/geistdocs 1.3.0-canary.5af98bc → 1.3.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 (362) 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 +15 -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} +2 -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-nextjs.d.ts +8 -0
  50. package/dist/assets/logos/logo-nextjs.d.ts.map +1 -0
  51. package/dist/assets/logos/logo-nextjs.js +7 -0
  52. package/dist/assets/logos/logo-streamdown.d.ts +8 -0
  53. package/dist/assets/logos/logo-streamdown.d.ts.map +1 -0
  54. package/dist/assets/logos/logo-streamdown.js +8 -0
  55. package/dist/assets/logos/logo-svelte-kit.d.ts +8 -0
  56. package/dist/assets/logos/logo-svelte-kit.d.ts.map +1 -0
  57. package/dist/assets/logos/logo-svelte-kit.js +7 -0
  58. package/dist/assets/logos/logo-vercel-oss.d.ts +8 -0
  59. package/dist/assets/logos/logo-vercel-oss.d.ts.map +1 -0
  60. package/dist/assets/logos/logo-vercel-oss.js +7 -0
  61. package/dist/assets/logos/logo-workflow-sdk.d.ts +8 -0
  62. package/dist/assets/logos/logo-workflow-sdk.d.ts.map +1 -0
  63. package/dist/assets/logos/logo-workflow-sdk.js +8 -0
  64. package/dist/cli/index.js +1 -1
  65. package/dist/components/button-group.d.ts +2 -0
  66. package/dist/components/button-group.d.ts.map +1 -0
  67. package/dist/components/button-group.js +2 -0
  68. package/dist/components/button.d.ts +2 -0
  69. package/dist/components/button.d.ts.map +1 -0
  70. package/dist/components/button.js +2 -0
  71. package/dist/components/card.d.ts +2 -0
  72. package/dist/components/card.d.ts.map +1 -0
  73. package/dist/components/card.js +2 -0
  74. package/dist/components/code-block-tabs.js +3 -3
  75. package/dist/components/code-block.js +3 -3
  76. package/dist/components/collapsible.d.ts +2 -0
  77. package/dist/components/collapsible.d.ts.map +1 -0
  78. package/dist/components/collapsible.js +3 -0
  79. package/dist/components/copy-prompt.js +3 -3
  80. package/dist/components/dialog.d.ts +13 -0
  81. package/dist/components/dialog.d.ts.map +1 -0
  82. package/dist/components/dialog.js +35 -0
  83. package/dist/components/drawer.d.ts +2 -0
  84. package/dist/components/drawer.d.ts.map +1 -0
  85. package/dist/components/drawer.js +3 -0
  86. package/dist/components/dropdown-menu.d.ts +2 -0
  87. package/dist/components/dropdown-menu.d.ts.map +1 -0
  88. package/dist/components/dropdown-menu.js +3 -0
  89. package/dist/components/input-group.d.ts +2 -0
  90. package/dist/components/input-group.d.ts.map +1 -0
  91. package/dist/components/input-group.js +3 -0
  92. package/dist/components/input.d.ts +2 -0
  93. package/dist/components/input.d.ts.map +1 -0
  94. package/dist/components/input.js +2 -0
  95. package/dist/components/kbd.d.ts +2 -0
  96. package/dist/components/kbd.d.ts.map +1 -0
  97. package/dist/components/kbd.js +2 -0
  98. package/dist/components/navigation-menu.d.ts +2 -0
  99. package/dist/components/navigation-menu.d.ts.map +1 -0
  100. package/dist/components/navigation-menu.js +3 -0
  101. package/dist/components/popover.d.ts +2 -0
  102. package/dist/components/popover.d.ts.map +1 -0
  103. package/dist/components/popover.js +3 -0
  104. package/dist/components/scroll-area.d.ts +2 -0
  105. package/dist/components/scroll-area.d.ts.map +1 -0
  106. package/dist/components/scroll-area.js +3 -0
  107. package/dist/components/separator.d.ts +2 -0
  108. package/dist/components/separator.d.ts.map +1 -0
  109. package/dist/components/separator.js +3 -0
  110. package/dist/components/sheet.d.ts +2 -0
  111. package/dist/components/sheet.d.ts.map +1 -0
  112. package/dist/components/sheet.js +3 -0
  113. package/dist/components/sonner.d.ts +2 -0
  114. package/dist/components/sonner.d.ts.map +1 -0
  115. package/dist/components/sonner.js +3 -0
  116. package/dist/components/spinner.d.ts +2 -0
  117. package/dist/components/spinner.d.ts.map +1 -0
  118. package/dist/components/spinner.js +2 -0
  119. package/dist/components/textarea.d.ts +2 -0
  120. package/dist/components/textarea.d.ts.map +1 -0
  121. package/dist/components/textarea.js +2 -0
  122. package/dist/components/tooltip.d.ts +2 -0
  123. package/dist/components/tooltip.d.ts.map +1 -0
  124. package/dist/components/tooltip.js +3 -0
  125. package/dist/config.d.ts +66 -1
  126. package/dist/config.d.ts.map +1 -1
  127. package/dist/controls.js +4 -4
  128. package/dist/footer.d.ts +8 -0
  129. package/dist/footer.d.ts.map +1 -0
  130. package/dist/footer.js +6 -0
  131. package/dist/home-layout.d.ts +11 -0
  132. package/dist/home-layout.d.ts.map +1 -0
  133. package/dist/home-layout.js +31 -0
  134. package/dist/internal/chat/conversation.js +1 -1
  135. package/dist/internal/chat/message.js +1 -1
  136. package/dist/internal/chat/prompt-input.js +1 -1
  137. package/dist/internal/chat/shell.d.ts.map +1 -1
  138. package/dist/internal/chat/shell.js +6 -5
  139. package/dist/internal/chat/sources.js +1 -1
  140. package/dist/internal/config-context.d.ts +10 -0
  141. package/dist/internal/config-context.d.ts.map +1 -0
  142. package/dist/internal/config-context.js +15 -0
  143. package/dist/internal/footer/github-button.d.ts +7 -0
  144. package/dist/internal/footer/github-button.d.ts.map +1 -0
  145. package/dist/internal/footer/github-button.js +10 -0
  146. package/dist/internal/footer/rss-button.d.ts +2 -0
  147. package/dist/internal/footer/rss-button.d.ts.map +1 -0
  148. package/dist/internal/footer/rss-button.js +4 -0
  149. package/dist/internal/localized-link.d.ts +8 -0
  150. package/dist/internal/localized-link.d.ts.map +1 -0
  151. package/dist/internal/localized-link.js +13 -0
  152. package/dist/internal/navbar/desktop-menu.d.ts +10 -0
  153. package/dist/internal/navbar/desktop-menu.d.ts.map +1 -0
  154. package/dist/internal/navbar/desktop-menu.js +11 -0
  155. package/dist/internal/navbar/mobile-menu.d.ts +7 -0
  156. package/dist/internal/navbar/mobile-menu.d.ts.map +1 -0
  157. package/dist/internal/navbar/mobile-menu.js +44 -0
  158. package/dist/internal/navbar/navbar-logo.d.ts +16 -0
  159. package/dist/internal/navbar/navbar-logo.d.ts.map +1 -0
  160. package/dist/internal/navbar/navbar-logo.js +30 -0
  161. package/dist/internal/page-actions-client.d.ts.map +1 -1
  162. package/dist/internal/page-actions-client.js +17 -6
  163. package/dist/internal/page-visibility.d.ts +18 -0
  164. package/dist/internal/page-visibility.d.ts.map +1 -0
  165. package/dist/internal/page-visibility.js +24 -0
  166. package/dist/internal/provider-client.d.ts +1 -1
  167. package/dist/internal/provider-client.d.ts.map +1 -1
  168. package/dist/internal/provider-client.js +2 -1
  169. package/dist/internal/sidebar.d.ts +4 -1
  170. package/dist/internal/sidebar.d.ts.map +1 -1
  171. package/dist/internal/sidebar.js +4 -4
  172. package/dist/internal/ui/button-group.js +2 -2
  173. package/dist/internal/ui/button.d.ts +1 -1
  174. package/dist/internal/ui/button.d.ts.map +1 -1
  175. package/dist/internal/ui/button.js +7 -7
  176. package/dist/internal/ui/card.js +1 -1
  177. package/dist/internal/ui/drawer.js +1 -1
  178. package/dist/internal/ui/dropdown-menu.js +7 -7
  179. package/dist/internal/ui/input-group.js +2 -2
  180. package/dist/internal/ui/input.js +1 -1
  181. package/dist/internal/ui/kbd.js +1 -1
  182. package/dist/internal/ui/navigation-menu.d.ts +17 -0
  183. package/dist/internal/ui/navigation-menu.d.ts.map +1 -0
  184. package/dist/internal/ui/navigation-menu.js +38 -0
  185. package/dist/internal/ui/popover.js +1 -1
  186. package/dist/internal/ui/scroll-area.js +2 -2
  187. package/dist/internal/ui/separator.js +1 -1
  188. package/dist/internal/ui/sheet.js +4 -4
  189. package/dist/internal/ui/sonner.js +3 -3
  190. package/dist/internal/ui/textarea.js +1 -1
  191. package/dist/internal/ui/tooltip.js +1 -1
  192. package/dist/layout.d.ts +2 -1
  193. package/dist/layout.d.ts.map +1 -1
  194. package/dist/layout.js +2 -2
  195. package/dist/mdx.d.ts +55 -24
  196. package/dist/mdx.d.ts.map +1 -1
  197. package/dist/mdx.js +7 -46
  198. package/dist/mobile-docs-bar.d.ts +7 -0
  199. package/dist/mobile-docs-bar.d.ts.map +1 -0
  200. package/dist/mobile-docs-bar.js +13 -0
  201. package/dist/navbar.d.ts +7 -0
  202. package/dist/navbar.d.ts.map +1 -0
  203. package/dist/navbar.js +10 -0
  204. package/dist/pages/docs.d.ts +33 -5
  205. package/dist/pages/docs.d.ts.map +1 -1
  206. package/dist/pages/docs.js +46 -17
  207. package/dist/proxy.d.ts +24 -8
  208. package/dist/proxy.d.ts.map +1 -1
  209. package/dist/proxy.js +116 -36
  210. package/dist/routes/agents.d.ts +21 -0
  211. package/dist/routes/agents.d.ts.map +1 -0
  212. package/dist/routes/agents.js +201 -0
  213. package/dist/routes/chat.d.ts +11 -5
  214. package/dist/routes/chat.d.ts.map +1 -1
  215. package/dist/routes/chat.js +386 -65
  216. package/dist/routes/llms.d.ts +29 -10
  217. package/dist/routes/llms.d.ts.map +1 -1
  218. package/dist/routes/llms.js +80 -9
  219. package/dist/routes/search.d.ts +8 -5
  220. package/dist/routes/search.d.ts.map +1 -1
  221. package/dist/routes/search.js +52 -4
  222. package/dist/routes/sitemap.d.ts +15 -3
  223. package/dist/routes/sitemap.d.ts.map +1 -1
  224. package/dist/routes/sitemap.js +32 -6
  225. package/dist/shiki-theme.d.ts +20 -0
  226. package/dist/shiki-theme.d.ts.map +1 -0
  227. package/dist/shiki-theme.js +110 -0
  228. package/dist/source-config.d.ts +68 -0
  229. package/dist/source-config.d.ts.map +1 -0
  230. package/dist/source-config.js +161 -0
  231. package/dist/source.d.ts +155 -4
  232. package/dist/source.d.ts.map +1 -1
  233. package/dist/source.js +73 -3
  234. package/dist/versions.d.ts +45 -0
  235. package/dist/versions.d.ts.map +1 -0
  236. package/dist/versions.js +79 -0
  237. package/package.json +134 -9
  238. package/source-config.js +174 -0
  239. package/styles.css +465 -102
  240. package/template/AGENTS.md +95 -0
  241. package/template/app/[lang]/(home)/components/centered-section.tsx +1 -3
  242. package/template/app/[lang]/(home)/components/hero.tsx +2 -2
  243. package/template/app/[lang]/(home)/components/one-two-section.tsx +1 -3
  244. package/template/app/[lang]/(home)/components/templates.tsx +3 -5
  245. package/template/app/[lang]/(home)/components/text-grid-section.tsx +1 -1
  246. package/template/app/[lang]/(home)/layout.tsx +4 -3
  247. package/template/app/[lang]/(home)/page.tsx +2 -2
  248. package/template/app/[lang]/agents.md/route.ts +6 -0
  249. package/template/app/[lang]/docs/[[...slug]]/page.tsx +4 -1
  250. package/template/app/[lang]/layout.tsx +6 -6
  251. package/template/app/[lang]/llms.mdx/[[...slug]]/route.ts +1 -1
  252. package/template/app/[lang]/llms.txt/route.ts +1 -1
  253. package/template/app/[lang]/sitemap.md/route.ts +2 -2
  254. package/template/app/api/chat/route.ts +12 -1
  255. package/template/app/api/search/route.ts +2 -2
  256. package/template/app/styles/geistdocs.css +150 -109
  257. package/template/components/ui/badge.tsx +5 -5
  258. package/template/components/ui/button.tsx +7 -7
  259. package/template/components/ui/command-prompt.tsx +2 -2
  260. package/template/content/docs/agent-readiness.mdx +103 -0
  261. package/template/content/docs/ask-ai.mdx +57 -5
  262. package/template/content/docs/configuration.cn.mdx +47 -7
  263. package/template/content/docs/configuration.mdx +158 -1
  264. package/template/content/docs/deployment.mdx +11 -0
  265. package/template/content/docs/edit-on-github.mdx +2 -2
  266. package/template/content/docs/env.mdx +36 -5
  267. package/template/content/docs/feedback.mdx +2 -2
  268. package/template/content/docs/getting-started.cn.mdx +2 -2
  269. package/template/content/docs/getting-started.mdx +8 -1
  270. package/template/content/docs/index.cn.mdx +36 -33
  271. package/template/content/docs/index.mdx +12 -0
  272. package/template/content/docs/internationalization.mdx +1 -1
  273. package/template/content/docs/llms-txt.cn.mdx +24 -2
  274. package/template/content/docs/llms-txt.mdx +44 -12
  275. package/template/content/docs/md.cn.mdx +12 -15
  276. package/template/content/docs/md.mdx +26 -16
  277. package/template/content/docs/meta.json +4 -0
  278. package/template/content/docs/migration.mdx +364 -0
  279. package/template/content/docs/open-in-chat.mdx +8 -10
  280. package/template/content/docs/provider.cn.mdx +6 -5
  281. package/template/content/docs/provider.mdx +9 -8
  282. package/template/content/docs/proxy.cn.mdx +96 -0
  283. package/template/content/docs/proxy.mdx +178 -0
  284. package/template/content/docs/rss.mdx +2 -2
  285. package/template/content/docs/syntax.mdx +1 -1
  286. package/template/content/docs/theme-aware-image.mdx +1 -1
  287. package/template/content/docs/versioned-docs.cn.mdx +117 -0
  288. package/template/content/docs/versioned-docs.mdx +228 -0
  289. package/template/geistdocs.tsx +26 -0
  290. package/template/lib/geistdocs/config.tsx +3 -0
  291. package/template/package.json +5 -5
  292. package/template/proxy.ts +2 -1
  293. package/template/source.config.ts +8 -47
  294. package/template/app/actions/feedback/emotions.ts +0 -18
  295. package/template/app/actions/feedback/index.ts +0 -45
  296. package/template/components/geistcn-fallbacks/geistcn-assets/icons/icon-arrow-up-right-small.tsx +0 -35
  297. package/template/components/geistcn-fallbacks/geistcn-assets/icons/icon-arrow-up-right.tsx +0 -27
  298. package/template/components/geistcn-fallbacks/geistcn-assets/icons/icon-check.tsx +0 -27
  299. package/template/components/geistcn-fallbacks/geistcn-assets/icons/icon-chevron-down-small.tsx +0 -30
  300. package/template/components/geistcn-fallbacks/geistcn-assets/icons/icon-chevron-right.tsx +0 -27
  301. package/template/components/geistcn-fallbacks/geistcn-assets/icons/icon-copy.tsx +0 -27
  302. package/template/components/geistcn-fallbacks/geistcn-assets/icons/icon-file-text.tsx +0 -25
  303. package/template/components/geistcn-fallbacks/geistcn-assets/icons/icon-menu-alt.tsx +0 -27
  304. package/template/components/geistcn-fallbacks/geistcn-assets/icons/icon-slash-forward.tsx +0 -36
  305. package/template/components/geistcn-fallbacks/geistcn-assets/logos/logo-ai-elements.tsx +0 -29
  306. package/template/components/geistcn-fallbacks/geistcn-assets/logos/logo-ai-sdk.tsx +0 -38
  307. package/template/components/geistcn-fallbacks/geistcn-assets/logos/logo-chat-sdk.tsx +0 -42
  308. package/template/components/geistcn-fallbacks/geistcn-assets/logos/logo-flags-sdk.tsx +0 -42
  309. package/template/components/geistcn-fallbacks/geistcn-assets/logos/logo-icon-vercel.tsx +0 -31
  310. package/template/components/geistcn-fallbacks/geistcn-assets/logos/logo-streamdown.tsx +0 -29
  311. package/template/components/geistcn-fallbacks/geistcn-assets/logos/logo-vercel-oss.tsx +0 -24
  312. package/template/components/geistcn-fallbacks/geistcn-assets/logos/logo-workflow-sdk.tsx +0 -73
  313. package/template/components/geistdocs/callout.tsx +0 -40
  314. package/template/components/geistdocs/chat.tsx +0 -24
  315. package/template/components/geistdocs/code-block-tabs.tsx +0 -61
  316. package/template/components/geistdocs/code-block.tsx +0 -134
  317. package/template/components/geistdocs/copy-page.tsx +0 -27
  318. package/template/components/geistdocs/desktop-menu.tsx +0 -52
  319. package/template/components/geistdocs/docs-page.tsx +0 -35
  320. package/template/components/geistdocs/edit-source.tsx +0 -30
  321. package/template/components/geistdocs/feedback.tsx +0 -139
  322. package/template/components/geistdocs/footer.tsx +0 -30
  323. package/template/components/geistdocs/github-button.tsx +0 -19
  324. package/template/components/geistdocs/home-layout.tsx +0 -46
  325. package/template/components/geistdocs/icons.tsx +0 -13
  326. package/template/components/geistdocs/installer.tsx +0 -58
  327. package/template/components/geistdocs/language-selector.tsx +0 -3
  328. package/template/components/geistdocs/mermaid.tsx +0 -68
  329. package/template/components/geistdocs/mobile-docs-bar.tsx +0 -77
  330. package/template/components/geistdocs/mobile-menu.tsx +0 -150
  331. package/template/components/geistdocs/navbar-logo.tsx +0 -124
  332. package/template/components/geistdocs/navbar.tsx +0 -22
  333. package/template/components/geistdocs/rss-button.tsx +0 -10
  334. package/template/components/geistdocs/scroll-top.tsx +0 -21
  335. package/template/components/geistdocs/search.tsx +0 -17
  336. package/template/components/geistdocs/sidebar.tsx +0 -128
  337. package/template/components/geistdocs/theme-aware-image.tsx +0 -22
  338. package/template/components/geistdocs/theme-toggle.tsx +0 -3
  339. package/template/components/geistdocs/video.tsx +0 -16
  340. package/template/components/ui/button-group.tsx +0 -83
  341. package/template/components/ui/card.tsx +0 -92
  342. package/template/components/ui/collapsible.tsx +0 -33
  343. package/template/components/ui/command.tsx +0 -184
  344. package/template/components/ui/dialog.tsx +0 -143
  345. package/template/components/ui/drawer.tsx +0 -135
  346. package/template/components/ui/dropdown-menu.tsx +0 -257
  347. package/template/components/ui/hover-card.tsx +0 -44
  348. package/template/components/ui/input-group.tsx +0 -170
  349. package/template/components/ui/input.tsx +0 -21
  350. package/template/components/ui/kbd.tsx +0 -28
  351. package/template/components/ui/navigation-menu.tsx +0 -192
  352. package/template/components/ui/popover.tsx +0 -48
  353. package/template/components/ui/scroll-area.tsx +0 -58
  354. package/template/components/ui/select.tsx +0 -187
  355. package/template/components/ui/separator.tsx +0 -28
  356. package/template/components/ui/sheet.tsx +0 -139
  357. package/template/components/ui/sonner.tsx +0 -40
  358. package/template/components/ui/spinner.tsx +0 -16
  359. package/template/components/ui/textarea.tsx +0 -18
  360. package/template/components/ui/tooltip.tsx +0 -61
  361. package/template/hooks/geistdocs/use-sidebar.ts +0 -13
  362. package/template/hooks/use-mobile.ts +0 -19
@@ -4,19 +4,21 @@ 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
10
+ - /docs/proxy
9
11
  ---
10
12
 
11
- Geistdocs implements the [llms.txt standard](https://llmstxt.org/) - a convention that provides all your documentation content in a single, AI-readable text file. This makes it easy for language models to understand your entire documentation at once.
13
+ Geistdocs implements the [llms.txt standard](https://llmstxt.org/), a convention for exposing documentation as one AI-readable text file. Language models and coding agents can use `/llms.txt` to retrieve broad documentation context.
12
14
 
13
15
  <CopyPrompt text="Help me verify this Geistdocs site's AI-readable docs. Check /llms.txt and a few .mdx page URLs, then explain whether an AI assistant can retrieve the full documentation context.">
14
16
  Help me verify this Geistdocs site's AI-readable docs. Check `/llms.txt` and a few `.mdx` page URLs, then explain whether an AI assistant can retrieve the full documentation context.
15
17
  </CopyPrompt>
16
18
 
17
- ## What It Is
19
+ ## What it is
18
20
 
19
- The `/llms.txt` endpoint returns all your documentation pages as plain Markdown in a single response. Each page is separated by blank lines, making it easy for AI tools to parse and understand your complete documentation.
21
+ The `/llms.txt` endpoint returns all configured documentation pages as Markdown in a single response. Each page is separated by blank lines so AI tools can parse the complete documentation set.
20
22
 
21
23
  ### Access
22
24
 
@@ -24,20 +26,20 @@ The `/llms.txt` endpoint returns all your documentation pages as plain Markdown
24
26
  https://yourdomain.com/llms.txt
25
27
  ```
26
28
 
27
- Returns all documentation pages concatenated together as plain text.
29
+ Returns all documentation pages concatenated together as Markdown.
28
30
 
29
- ## How It Works
31
+ ## How it works
30
32
 
31
- The endpoint:
33
+ The package route helper:
32
34
 
33
- 1. Fetches all pages from your documentation
34
- 2. Processes each page to extract clean Markdown
35
- 3. Combines everything into a single text file
36
- 4. Returns it as `text/plain`
35
+ 1. Fetches pages from one or more source bundles.
36
+ 2. Processes each page to extract clean Markdown.
37
+ 3. Combines the pages into a single response.
38
+ 4. Returns the response as `text/markdown`.
37
39
 
38
40
  Pages are joined with double newlines (`\n\n`) for clear separation.
39
41
 
40
- ## Use Cases
42
+ ## Use cases
41
43
 
42
44
  This feature enables:
43
45
 
@@ -47,7 +49,37 @@ This feature enables:
47
49
  - **Bulk Processing** - Process all documentation at once
48
50
  - **LLM Context** - Give language models complete documentation context
49
51
 
50
- ## The llms.txt Standard
52
+ ## Configure sources
53
+
54
+ Generated projects use one documentation source:
55
+
56
+ ```ts title="app/[lang]/llms.txt/route.ts"
57
+ import { createLlmsRoute } from "@vercel/geistdocs/routes/llms";
58
+ import { geistdocsSource } from "@/lib/geistdocs/source";
59
+
60
+ export const { GET, revalidate } = createLlmsRoute({
61
+ source: geistdocsSource,
62
+ });
63
+ ```
64
+
65
+ Sites with multiple content sections or versions can pass `sources`:
66
+
67
+ ```ts title="app/[lang]/llms.txt/route.ts"
68
+ export const { GET, revalidate } = createLlmsRoute({
69
+ sources: [docsSource, cookbookSource],
70
+ });
71
+ ```
72
+
73
+ Use `filterPage` to exclude pages from `/llms.txt`, such as internal or preview-only docs:
74
+
75
+ ```ts title="app/[lang]/llms.txt/route.ts"
76
+ export const { GET, revalidate } = createLlmsRoute({
77
+ source: geistdocsSource,
78
+ filterPage: (page) => !page.url.includes("/internal"),
79
+ });
80
+ ```
81
+
82
+ ## The llms.txt standard
51
83
 
52
84
  The llms.txt standard is a simple convention that makes documentation more accessible to AI tools. It's similar in spirit to `robots.txt` but designed for language models instead of search crawlers.
53
85
 
@@ -5,9 +5,10 @@ type: conceptual
5
5
  summary: 通过在 URL 后追加 .md 或 .mdx 以原始 Markdown 格式访问任何文档页面,供 AI 工具使用。
6
6
  related:
7
7
  - /docs/llms-txt
8
+ - /docs/proxy
8
9
  ---
9
10
 
10
- Geistdocs 包含一个内置功能,允许 AI 工具和语言模型以纯 Markdown 的形式访问你的文档。只需在任何文档页面的 URL 后追加 `.mdx`,即可获取处理后的 Markdown 内容。
11
+ Geistdocs 允许 AI 工具和语言模型以纯 Markdown 的形式访问文档页面。在文档 URL 后追加 `.md` 或 `.mdx`,即可获取该页面处理后的 Markdown 内容。
11
12
 
12
13
  ## 工作原理
13
14
 
@@ -40,22 +41,18 @@ https://yourdomain.com/docs/getting-started.mdx
40
41
 
41
42
  ## 实现
42
43
 
43
- 该功能使用 Next.js 的重写规则,将 `.mdx` 请求路由到一个特殊端点:
44
+ 包内 proxy 会将 `.md` 和 `.mdx` 请求路由到返回 Markdown 的 route handler:
44
45
 
45
- **next.config.ts**
46
-
47
- ```typescript
48
- async rewrites() {
49
- return [
50
- {
51
- source: "/docs/:path*.mdx",
52
- destination: "/llms.mdx/:path*",
53
- },
54
- ];
55
- }
46
+ ```ts title="proxy.ts"
47
+ const proxy = createProxy({
48
+ config: geistdocsConfig,
49
+ markdownRoutes: [
50
+ { from: "/docs/*path", to: "/[lang]/llms.mdx/*path" },
51
+ ],
52
+ });
56
53
  ```
57
54
 
58
- 该端点会处理页面并以 `text/markdown` 内容类型返回纯 Markdown。
55
+ 目标 route 使用 `createDocsMarkdownRoute` 处理页面,并以 `text/markdown` 内容类型返回 Markdown。
59
56
 
60
57
  ## 响应格式
61
58
 
@@ -65,4 +62,4 @@ async rewrites() {
65
62
  - 页面标题作为一级标题
66
63
  - 来自 Fumadocs 的处理后 Markdown 内容
67
64
 
68
- 所有 MDX 组件都会被处理并转换为等效的纯 Markdown。
65
+ 所有 MDX 组件都会被处理并转换为等效的纯 Markdown。
@@ -4,18 +4,20 @@ 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
9
+ - /docs/proxy
8
10
  ---
9
11
 
10
- Geistdocs includes a built-in feature that allows AI tools and language models to access your documentation as plain Markdown. Simply append `.mdx` to any documentation page URL to get the processed Markdown content.
12
+ Geistdocs lets AI tools and language models access documentation pages as plain Markdown. Append `.md` or `.mdx` to a documentation URL to get the processed Markdown content for that page.
11
13
 
12
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.">
13
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.
14
16
  </CopyPrompt>
15
17
 
16
- ## How It Works
18
+ ## How it works
17
19
 
18
- When you add `.md` or `.mdx` to any documentation URL, you get back the page content as plain text Markdown instead of the rendered HTML. This makes it easy for AI tools to read and understand your documentation.
20
+ When you add `.md` or `.mdx` to a documentation URL, Geistdocs returns the page content as Markdown instead of rendered HTML. AI tools can use that response as focused context for one page.
19
21
 
20
22
  ### Example
21
23
 
@@ -33,7 +35,7 @@ The `.mdx` version returns:
33
35
  - The full processed Markdown content
34
36
  - No HTML, styling, or navigation
35
37
 
36
- ## Use Cases
38
+ ## Use cases
37
39
 
38
40
  This feature is particularly useful for:
39
41
 
@@ -44,22 +46,30 @@ This feature is particularly useful for:
44
46
 
45
47
  ## Implementation
46
48
 
47
- The feature uses a Next.js rewrite rule to route `.mdx` requests to a special endpoint:
49
+ The package proxy routes `.md` and `.mdx` requests to the package-backed markdown route handler:
48
50
 
49
- **next.config.ts**
51
+ ```ts title="proxy.ts"
52
+ const proxy = createProxy({
53
+ config: geistdocsConfig,
54
+ markdownRoutes: [
55
+ { from: "/docs/*path", to: "/[lang]/llms.mdx/*path" },
56
+ ],
57
+ });
58
+ ```
59
+
60
+ The destination route uses `createDocsMarkdownRoute` to process the page and return Markdown with a `text/markdown` content type:
61
+
62
+ ```ts title="app/[lang]/llms.mdx/[[...slug]]/route.ts"
63
+ import { createDocsMarkdownRoute } from "@vercel/geistdocs/routes/llms";
64
+ import { geistdocsSource } from "@/lib/geistdocs/source";
50
65
 
51
- ```typescript
52
- async rewrites() {
53
- return [
54
- {
55
- source: "/docs/:path*.mdx",
56
- destination: "/llms.mdx/:path*",
57
- },
58
- ];
59
- }
66
+ export const { GET, generateStaticParams, revalidate } =
67
+ createDocsMarkdownRoute({
68
+ sources: [geistdocsSource],
69
+ });
60
70
  ```
61
71
 
62
- The endpoint processes the page and returns plain Markdown with a `text/markdown` content type.
72
+ Read [Proxy and markdown routes](/docs/proxy) to configure additional route families such as `/cookbook` or `/v5/docs`.
63
73
 
64
74
  ## Response Format
65
75
 
@@ -7,14 +7,18 @@
7
7
  "getting-started",
8
8
  "env",
9
9
  "deployment",
10
+ "migration",
10
11
  "configuration",
11
12
  "---Internals---",
12
13
  "syntax",
13
14
  "provider",
15
+ "versioned-docs",
16
+ "proxy",
14
17
  "---Features---",
15
18
  "...",
16
19
  "---AI---",
17
20
  "open-in-chat",
21
+ "agent-readiness",
18
22
  "llms-txt",
19
23
  "ask-ai"
20
24
  ]
@@ -0,0 +1,364 @@
1
+ ---
2
+ title: Migration guide
3
+ description: Migrate a Fumadocs or custom Geist docs site to package-backed Geistdocs
4
+ type: guide
5
+ summary: Move an existing documentation site to @vercel/geistdocs while keeping local content, routing, middleware behavior, and AI-readable surfaces intact.
6
+ prerequisites:
7
+ - /docs/configuration
8
+ - /docs/proxy
9
+ related:
10
+ - /docs/versioned-docs
11
+ - /docs/llms-txt
12
+ - /docs/agent-readiness
13
+ ---
14
+
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
+
17
+ <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
+ 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
+ </CopyPrompt>
20
+
21
+ ## Before you migrate
22
+
23
+ Create a working branch and inventory the current site before replacing code:
24
+
25
+ - Existing Fumadocs collections in `source.config.ts`.
26
+ - Public route families, such as `/docs`, `/api-reference`, `/guides`, or `/`.
27
+ - Existing `middleware.ts` or `proxy.ts` behavior.
28
+ - Static files that overlap package routes, such as `public/llms.txt`.
29
+ - Search, chat, `llms.txt`, page-level Markdown, `sitemap.md`, `agents.md`, RSS, and Open Graph routes.
30
+ - Tailwind CSS version and custom plugins.
31
+ - Direct app usage of `ai` or `@ai-sdk/react` outside Geistdocs.
32
+ - Environment variables required by the homepage, docs routes, or API routes.
33
+
34
+ Run the current project before changing it:
35
+
36
+ ```bash title="Terminal"
37
+ pnpm install
38
+ pnpm build
39
+ ```
40
+
41
+ Fix unrelated build failures first. A migration is safer when the starting point is reproducible.
42
+
43
+ ## Install Geistdocs
44
+
45
+ Add `@vercel/geistdocs` and align the supported Fumadocs and Next.js dependencies for the package version you are adopting.
46
+
47
+ For an existing project, use your package manager directly:
48
+
49
+ ```bash title="Terminal"
50
+ pnpm add @vercel/geistdocs
51
+ ```
52
+
53
+ If you are starting from a generated Geistdocs project and moving content into it, use the CLI:
54
+
55
+ ```bash title="Terminal"
56
+ pnpm dlx @vercel/geistdocs init --name my-docs
57
+ ```
58
+
59
+ ## Align Ask AI dependencies
60
+
61
+ Geistdocs Ask AI uses AI SDK v6. Generated projects install `ai` v6 and `@ai-sdk/react` v3 so package-owned chat components and route helpers use the supported AI SDK APIs.
62
+
63
+ If the existing app imports `ai` or `@ai-sdk/react` for product-specific features, migrate that code separately. Keep Geistdocs route adapters package-backed, and do not copy package chat internals into the app to preserve older AI SDK behavior.
64
+
65
+ ## Update source config
66
+
67
+ Use the source-config-safe export from `@vercel/geistdocs/source-config` in `source.config.ts`. This file is evaluated by `fumadocs-mdx` during dependency installation and builds, so avoid importing runtime component entry points from it.
68
+
69
+ ```ts title="source.config.ts"
70
+ import {
71
+ defineGeistdocsSourceConfig,
72
+ geistdocsFrontmatterSchema,
73
+ geistdocsMetaSchema,
74
+ } from "@vercel/geistdocs/source-config";
75
+ import { defineDocs } from "fumadocs-mdx/config";
76
+
77
+ export const docs = defineDocs({
78
+ dir: "content/docs",
79
+ docs: {
80
+ schema: geistdocsFrontmatterSchema,
81
+ postprocess: {
82
+ includeProcessedMarkdown: true,
83
+ },
84
+ },
85
+ meta: {
86
+ schema: geistdocsMetaSchema,
87
+ },
88
+ });
89
+
90
+ export default defineGeistdocsSourceConfig();
91
+ ```
92
+
93
+ For multiple docs families, create one collection per directory and reuse `geistdocsFrontmatterSchema`.
94
+
95
+ ## Create the package config
96
+
97
+ Use `@vercel/geistdocs/config` to centralize site metadata and route families in `lib/geistdocs/config.tsx`.
98
+
99
+ ```tsx title="lib/geistdocs/config.tsx"
100
+ import { defineConfig } from "@vercel/geistdocs/config";
101
+ import { Logo, github, nav, prompt, suggestions, title } from "@/geistdocs";
102
+
103
+ export const config = defineConfig({
104
+ title,
105
+ defaultLanguage: "en",
106
+ logo: <Logo />,
107
+ github,
108
+ nav,
109
+ content: [{ id: "docs", label: "Docs", dir: "content/docs", route: "/docs" }],
110
+ ai: {
111
+ prompt,
112
+ suggestions,
113
+ },
114
+ });
115
+ ```
116
+
117
+ Set `content` to every public documentation route family. `createProxy` uses this metadata to infer standard Markdown mappings for non-root sections.
118
+
119
+ ## Connect Fumadocs sources
120
+
121
+ Wrap each Fumadocs collection with `createSource` in `lib/geistdocs/source.ts`.
122
+
123
+ ```ts title="lib/geistdocs/source.ts"
124
+ import { createSource } from "@vercel/geistdocs/source";
125
+ import { docs } from "@/.source/server";
126
+ import { config } from "./config";
127
+
128
+ export const geistdocsSource = createSource({
129
+ docs,
130
+ config,
131
+ id: "docs",
132
+ label: "Docs",
133
+ });
134
+
135
+ export const source = geistdocsSource.source;
136
+ ```
137
+
138
+ For root-mounted docs, set `baseUrl: "/"` and use explicit `markdownRoutes` in `proxy.ts`:
139
+
140
+ ```ts title="lib/geistdocs/source.ts"
141
+ export const geistdocsSource = createSource({
142
+ docs,
143
+ config,
144
+ baseUrl: "/",
145
+ });
146
+ ```
147
+
148
+ ## Add route adapters
149
+
150
+ Keep App Router files thin. Route files should call package helpers instead of copying package internals.
151
+
152
+ ```tsx title="app/[lang]/docs/[[...slug]]/page.tsx"
153
+ import { createDocsPage } from "@vercel/geistdocs/pages/docs";
154
+ import { config } from "@/lib/geistdocs/config";
155
+ import { geistdocsSource } from "@/lib/geistdocs/source";
156
+
157
+ const docsPage = createDocsPage({
158
+ config,
159
+ source: geistdocsSource,
160
+ openGraph: {
161
+ images: true,
162
+ },
163
+ });
164
+
165
+ export default docsPage.Page;
166
+ export const generateStaticParams = docsPage.generateStaticParams;
167
+ export const generateMetadata = docsPage.generateMetadata;
168
+ ```
169
+
170
+ Set `openGraph.images` to `true` only when your app includes the Geistdocs OG route. If you do not add the OG route, omit `openGraph` or override metadata to avoid broken `/og/...` references.
171
+
172
+ ## Add AI-readable routes
173
+
174
+ Add the package route helpers for machine-readable docs surfaces.
175
+
176
+ ```ts title="app/[lang]/llms.txt/route.ts"
177
+ import { createLlmsRoute } from "@vercel/geistdocs/routes/llms";
178
+ import { geistdocsSource } from "@/lib/geistdocs/source";
179
+
180
+ export const { GET, revalidate } = createLlmsRoute({
181
+ sources: [geistdocsSource],
182
+ });
183
+ ```
184
+
185
+ ```ts title="app/[lang]/llms.mdx/[[...slug]]/route.ts"
186
+ import { createDocsMarkdownRoute } from "@vercel/geistdocs/routes/llms";
187
+ import { geistdocsSource } from "@/lib/geistdocs/source";
188
+
189
+ export const { GET, generateStaticParams, revalidate } =
190
+ createDocsMarkdownRoute({
191
+ source: geistdocsSource,
192
+ });
193
+ ```
194
+
195
+ ```ts title="app/[lang]/sitemap.md/route.ts"
196
+ import { createSitemapMarkdownRoute } from "@vercel/geistdocs/routes/sitemap";
197
+ import { config } from "@/lib/geistdocs/config";
198
+ import { geistdocsSource } from "@/lib/geistdocs/source";
199
+
200
+ export const { GET, generateStaticParams, revalidate, dynamic } =
201
+ createSitemapMarkdownRoute({
202
+ config,
203
+ sources: [{ source: geistdocsSource.source }],
204
+ });
205
+ ```
206
+
207
+ ```ts title="app/[lang]/agents.md/route.ts"
208
+ import { createAgentsRoute } from "@vercel/geistdocs/routes/agents";
209
+ import { config } from "@/lib/geistdocs/config";
210
+
211
+ export const { GET, generateStaticParams, revalidate } = createAgentsRoute({
212
+ config,
213
+ });
214
+ ```
215
+
216
+ Delete `public/llms.txt` after adding `createLlmsRoute`. Static files in `public` can mask App Router route behavior.
217
+
218
+ ## Add search and Ask AI routes
219
+
220
+ Use package route helpers for search and chat. Keep these files as adapters so `@vercel/geistdocs` can ship AI SDK compatibility fixes.
221
+
222
+ ```ts title="app/api/search/route.ts"
223
+ import { createSearchRoute } from "@vercel/geistdocs/routes/search";
224
+ import { config } from "@/lib/geistdocs/config";
225
+ import { geistdocsSource } from "@/lib/geistdocs/source";
226
+
227
+ export const GET = createSearchRoute({ config, sources: [geistdocsSource] });
228
+ ```
229
+
230
+ ```ts title="app/api/chat/route.ts"
231
+ import { createChatRoute } from "@vercel/geistdocs/routes/chat";
232
+ import { config } from "@/lib/geistdocs/config";
233
+ import { geistdocsSource } from "@/lib/geistdocs/source";
234
+
235
+ const chatProxyUrl = process.env.GEISTDOCS_CHAT_PROXY_URL;
236
+ const chatProxyToken = process.env.GEISTDOCS_CHAT_PROXY_TOKEN;
237
+
238
+ export const { POST, maxDuration } = createChatRoute({
239
+ config,
240
+ proxy: chatProxyUrl
241
+ ? {
242
+ url: chatProxyUrl,
243
+ headers: chatProxyToken
244
+ ? { Authorization: `Bearer ${chatProxyToken}` }
245
+ : undefined,
246
+ }
247
+ : undefined,
248
+ sources: [geistdocsSource],
249
+ });
250
+ ```
251
+
252
+ Leave `GEISTDOCS_CHAT_PROXY_URL` unset for default AI Gateway mode. Set it to a `/vertex` proxy URL only when Ask AI should route model requests through the central Vertex-backed service.
253
+
254
+ ## Migrate middleware behavior
255
+
256
+ Use `createProxy` in `proxy.ts`. Put existing `middleware.ts` behavior in `before` or `after` hooks instead of replacing Geistdocs markdown negotiation.
257
+
258
+ ```ts title="proxy.ts"
259
+ import { createProxy } from "@vercel/geistdocs/proxy";
260
+ import { NextResponse } from "next/server";
261
+ import { config as geistdocsConfig } from "@/lib/geistdocs/config";
262
+
263
+ const proxy = createProxy({
264
+ config: geistdocsConfig,
265
+ before: async ({ request }) => {
266
+ if (request.nextUrl.pathname === "/legacy-docs") {
267
+ return NextResponse.redirect(new URL("/docs", request.url));
268
+ }
269
+
270
+ return null;
271
+ },
272
+ });
273
+
274
+ export const config = {
275
+ matcher: [
276
+ "/((?!api(?:/|$)|_next/static|_next/image|favicon.ico|sitemap.xml|robots.txt).*)",
277
+ ],
278
+ };
279
+
280
+ export default proxy;
281
+ ```
282
+
283
+ Use `api(?:/|$)` in the matcher. A broad `api` exclusion also excludes routes such as `/api-reference`.
284
+
285
+ ## Configure Markdown route mappings
286
+
287
+ For standard non-root sections, `createProxy` can infer Markdown routes from `config.content`.
288
+
289
+ Use explicit `markdownRoutes` when the public docs URL does not map directly to the Markdown route handler:
290
+
291
+ ```ts title="proxy.ts"
292
+ const proxy = createProxy({
293
+ config: geistdocsConfig,
294
+ markdownRoutes: [
295
+ { from: "/docs/*path", to: "/[lang]/llms.mdx/*path" },
296
+ { from: "/api-reference/*path", to: "/[lang]/llms.mdx/api-reference/*path" },
297
+ ],
298
+ });
299
+ ```
300
+
301
+ Root-mounted docs need explicit mappings. If a homepage or app routes also live at `/`, do not use a broad `/*path` mapping. Map each docs family separately:
302
+
303
+ ```ts title="proxy.ts"
304
+ const proxy = createProxy({
305
+ config: geistdocsConfig,
306
+ markdownRoutes: [
307
+ { from: "/guides/*path", to: "/[lang]/llms.mdx/guides/*path" },
308
+ { from: "/api-reference/*path", to: "/[lang]/llms.mdx/api-reference/*path" },
309
+ ],
310
+ });
311
+ ```
312
+
313
+ ## Configure Tailwind CSS
314
+
315
+ Tailwind CSS v4 requires `@source` entries for package components and related dependencies.
316
+
317
+ ```css title="app/styles/geistdocs.css"
318
+ @import "tailwindcss";
319
+ @import "fumadocs-ui/css/shadcn.css";
320
+ @import "fumadocs-ui/css/preset.css";
321
+ @import "tw-animate-css";
322
+
323
+ @source "../../node_modules/@vercel/geistdocs/dist/**/*.js";
324
+ @source "../../node_modules/streamdown/dist/*.js";
325
+ ```
326
+
327
+ Move Tailwind CSS v3 plugin utilities into CSS-first v4 utilities or theme variables. Keep custom token names stable while you migrate components.
328
+
329
+ ## Handle environment variables
330
+
331
+ Do not require production secrets for local migration builds. If a homepage or API route depends on a production-only secret, add a local fallback or disable that integration in development.
332
+
333
+ ```ts title="lib/example-secret.ts"
334
+ export const flagsSecret =
335
+ process.env.FLAGS_SECRET ??
336
+ (process.env.NODE_ENV === "development" ? "local-development-secret" : undefined);
337
+ ```
338
+
339
+ Keep real secrets in `.env.local` and out of Git.
340
+
341
+ ## Verify the migration
342
+
343
+ Run the same checks after each routing or source change:
344
+
345
+ ```bash title="Terminal"
346
+ pnpm postinstall
347
+ pnpm build
348
+ pnpm dev
349
+ ```
350
+
351
+ Check these URLs locally:
352
+
353
+ - `/docs` or the migrated docs root.
354
+ - `/llms.txt`.
355
+ - `/sitemap.md`.
356
+ - `/agents.md`.
357
+ - A page-level Markdown URL such as `/docs/getting-started.mdx`.
358
+ - A non-docs route that should not be rewritten as Markdown, such as the homepage.
359
+
360
+ ## Next steps
361
+
362
+ - Read [Configuration](/docs/configuration) to review package config options.
363
+ - Read [Proxy and markdown routes](/docs/proxy) to tune request handling.
364
+ - Read [Agent readiness](/docs/agent-readiness) to configure `/agents.md` for AI agents.
@@ -14,7 +14,7 @@ The "Open in Chat" feature enables users to seamlessly transfer documentation co
14
14
  Help me test Open in Chat for this Geistdocs site. Verify that page URLs resolve correctly, markdown endpoints work, and each configured AI platform receives useful context.
15
15
  </CopyPrompt>
16
16
 
17
- ## How It Works
17
+ ## How it works
18
18
 
19
19
  On every documentation page, users will find an "Open in chat" button in the table of contents sidebar. When clicked, a menu appears with options to open the page in various AI platforms:
20
20
 
@@ -65,18 +65,16 @@ Each platform has its own integration:
65
65
  - **Desktop applications** (Cursor): Open using a custom URL scheme that launches the application
66
66
  - **Specialized tools** (T3, Scira): Open with platform-specific parameters and context
67
67
 
68
- ## Benefits
68
+ ## Outcomes
69
69
 
70
70
  ### For Users
71
71
 
72
- 1. **Seamless Workflow** - No need to manually copy URLs or switch contexts
73
- 2. **Consistent Experience** - Same starting point regardless of preferred AI platform
74
- 3. **Time Saving** - Instant access to AI assistance with proper context
75
- 4. **Choice of Tools** - Use the AI platform they're most comfortable with
72
+ 1. **Context transfer**: Users do not need to manually copy URLs or switch contexts.
73
+ 2. **Consistent starting point**: Each AI platform receives the same page context.
74
+ 3. **Tool choice**: Users can open the AI platform they prefer.
76
75
 
77
76
  ### For Documentation Authors
78
77
 
79
- 1. **Enhanced Support** - Users can get help beyond what's in the docs
80
- 2. **Reduced Support Burden** - AI assistants handle common questions
81
- 3. **Better User Engagement** - Users can explore topics more deeply
82
- 4. **Platform Flexibility** - Support users' diverse AI preferences
78
+ 1. **More support paths**: Users can ask follow-up questions about a page.
79
+ 2. **Lower support load**: AI assistants can answer common documentation questions.
80
+ 3. **Platform flexibility**: Teams can support different AI preferences.
@@ -9,15 +9,16 @@ related:
9
9
  - /docs/configuration
10
10
  ---
11
11
 
12
- The `GeistdocsProvider` 是一个包装组件,位于应用的根部。它包装了 Fumadocs 的 `RootProvider`,并添加了 Geistdocs 特有的功能,使一切无缝运行。
12
+ `GeistdocsProvider` 位于应用根部,负责连接主题、搜索、AI chat、通知和可选分析功能。
13
13
 
14
14
  ## 它的作用
15
15
 
16
16
  该提供者为您处理以下主要事项:
17
17
 
18
- 2. **Toast 通知** - 提供一个全局通知系统,用于向用户反馈
19
- 3. **分析** - 集成 Vercel Analytics,用于跟踪页面浏览和性能
20
- 4. **搜索** - 配置搜索对话框并将其连接到您的搜索 API
18
+ 1. **Toast 通知**:提供全局通知系统,用于向用户反馈。
19
+ 2. **分析**:当本地 adapter 引入 Vercel Analytics 和 Speed Insights 时,将它们连接到站点。
20
+ 3. **搜索**:配置搜索对话框并连接到搜索 API。
21
+ 4. **Ask AI**:提供 chat 侧边栏和页面操作所需的客户端状态。
21
22
 
22
23
  ## 用法
23
24
 
@@ -66,4 +67,4 @@ toast.error("Something went wrong");
66
67
  - 用户交互
67
68
  - 性能指标
68
69
 
69
- 无需配置 —— 部署到 Vercel 后会自动生效。
70
+ 无需配置 —— 部署到 Vercel 后会自动生效。