@vercel/geistdocs 1.28.1 → 2.0.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 (544) hide show
  1. package/dist/assets/geistcn/__internal__/components/icon/base-icon.d.ts +59 -0
  2. package/dist/assets/geistcn/__internal__/components/icon/base-icon.d.ts.map +1 -0
  3. package/dist/assets/geistcn/__internal__/components/icon/base-icon.js +32 -0
  4. package/dist/assets/geistcn/__internal__/components/logo/base-logo-svg.d.ts +65 -0
  5. package/dist/assets/geistcn/__internal__/components/logo/base-logo-svg.d.ts.map +1 -0
  6. package/dist/assets/geistcn/__internal__/components/logo/base-logo-svg.js +41 -0
  7. package/dist/assets/geistcn/__internal__/types/color.d.ts +12 -0
  8. package/dist/assets/geistcn/__internal__/types/color.d.ts.map +1 -0
  9. package/dist/assets/geistcn/__internal__/types/color.js +25 -0
  10. package/dist/assets/geistcn/__internal__/types/icon.d.ts +6 -0
  11. package/dist/assets/geistcn/__internal__/types/icon.d.ts.map +1 -0
  12. package/dist/assets/geistcn/__internal__/types/icon.js +1 -0
  13. package/dist/assets/geistcn/__internal__/utils/calculate-icon-dimensions.d.ts +16 -0
  14. package/dist/assets/geistcn/__internal__/utils/calculate-icon-dimensions.d.ts.map +1 -0
  15. package/dist/assets/geistcn/__internal__/utils/calculate-icon-dimensions.js +15 -0
  16. package/dist/assets/geistcn/__internal__/utils/calculate-logo-dimensions.d.ts +30 -0
  17. package/dist/assets/geistcn/__internal__/utils/calculate-logo-dimensions.d.ts.map +1 -0
  18. package/dist/assets/geistcn/__internal__/utils/calculate-logo-dimensions.js +30 -0
  19. package/dist/assets/geistcn/__internal__/utils/parse-icon-size.d.ts +8 -0
  20. package/dist/assets/geistcn/__internal__/utils/parse-icon-size.d.ts.map +1 -0
  21. package/dist/assets/geistcn/__internal__/utils/parse-icon-size.js +13 -0
  22. package/dist/assets/geistcn/__internal__/utils/svg-color.d.ts +13 -0
  23. package/dist/assets/geistcn/__internal__/utils/svg-color.d.ts.map +1 -0
  24. package/dist/assets/geistcn/__internal__/utils/svg-color.js +10 -0
  25. package/dist/assets/geistcn/icons/named/icon-acronym-markdown.d.ts +26 -0
  26. package/dist/assets/geistcn/icons/named/icon-acronym-markdown.d.ts.map +1 -0
  27. package/dist/assets/geistcn/icons/named/icon-acronym-markdown.js +25 -0
  28. package/dist/assets/geistcn/icons/named/icon-archive.d.ts +26 -0
  29. package/dist/assets/geistcn/icons/named/icon-archive.d.ts.map +1 -0
  30. package/dist/assets/geistcn/icons/named/icon-archive.js +25 -0
  31. package/dist/assets/geistcn/icons/named/icon-arrow-circle-up.d.ts +26 -0
  32. package/dist/assets/geistcn/icons/named/icon-arrow-circle-up.d.ts.map +1 -0
  33. package/dist/assets/geistcn/icons/named/icon-arrow-circle-up.js +26 -0
  34. package/dist/assets/geistcn/icons/named/icon-arrow-down.d.ts +26 -0
  35. package/dist/assets/geistcn/icons/named/icon-arrow-down.d.ts.map +1 -0
  36. package/dist/assets/geistcn/icons/named/icon-arrow-down.js +25 -0
  37. package/dist/assets/geistcn/icons/named/icon-arrow-up-right-small.d.ts +26 -0
  38. package/dist/assets/geistcn/icons/named/icon-arrow-up-right-small.d.ts.map +1 -0
  39. package/dist/assets/geistcn/icons/named/icon-arrow-up-right-small.js +25 -0
  40. package/dist/assets/geistcn/icons/named/icon-arrow-up.d.ts +26 -0
  41. package/dist/assets/geistcn/icons/named/icon-arrow-up.d.ts.map +1 -0
  42. package/dist/assets/geistcn/icons/named/icon-arrow-up.js +25 -0
  43. package/dist/assets/geistcn/icons/named/icon-bookmark.d.ts +26 -0
  44. package/dist/assets/geistcn/icons/named/icon-bookmark.d.ts.map +1 -0
  45. package/dist/assets/geistcn/icons/named/icon-bookmark.js +25 -0
  46. package/dist/assets/geistcn/icons/named/icon-box.d.ts +26 -0
  47. package/dist/assets/geistcn/icons/named/icon-box.d.ts.map +1 -0
  48. package/dist/assets/geistcn/icons/named/icon-box.js +25 -0
  49. package/dist/assets/geistcn/icons/named/icon-check.d.ts +26 -0
  50. package/dist/assets/geistcn/icons/named/icon-check.d.ts.map +1 -0
  51. package/dist/assets/geistcn/icons/named/icon-check.js +25 -0
  52. package/dist/assets/geistcn/icons/named/icon-chevron-double-right.d.ts +26 -0
  53. package/dist/assets/geistcn/icons/named/icon-chevron-double-right.d.ts.map +1 -0
  54. package/dist/assets/geistcn/icons/named/icon-chevron-double-right.js +25 -0
  55. package/dist/assets/geistcn/icons/named/icon-chevron-down-small.d.ts +26 -0
  56. package/dist/assets/geistcn/icons/named/icon-chevron-down-small.d.ts.map +1 -0
  57. package/dist/assets/geistcn/icons/named/icon-chevron-down-small.js +25 -0
  58. package/dist/assets/geistcn/icons/named/icon-chevron-down.d.ts +26 -0
  59. package/dist/assets/geistcn/icons/named/icon-chevron-down.d.ts.map +1 -0
  60. package/dist/assets/geistcn/icons/named/icon-chevron-down.js +25 -0
  61. package/dist/assets/geistcn/icons/named/icon-chevron-left.d.ts +26 -0
  62. package/dist/assets/geistcn/icons/named/icon-chevron-left.d.ts.map +1 -0
  63. package/dist/assets/geistcn/icons/named/icon-chevron-left.js +25 -0
  64. package/dist/assets/geistcn/icons/named/icon-chevron-right-small.d.ts +26 -0
  65. package/dist/assets/geistcn/icons/named/icon-chevron-right-small.d.ts.map +1 -0
  66. package/dist/assets/geistcn/icons/named/icon-chevron-right-small.js +25 -0
  67. package/dist/assets/geistcn/icons/named/icon-chevron-right.d.ts +26 -0
  68. package/dist/assets/geistcn/icons/named/icon-chevron-right.d.ts.map +1 -0
  69. package/dist/assets/geistcn/icons/named/icon-chevron-right.js +25 -0
  70. package/dist/assets/geistcn/icons/named/icon-chevron-up-down.d.ts +26 -0
  71. package/dist/assets/geistcn/icons/named/icon-chevron-up-down.d.ts.map +1 -0
  72. package/dist/assets/geistcn/icons/named/icon-chevron-up-down.js +25 -0
  73. package/dist/assets/geistcn/icons/named/icon-chevron-up.d.ts +26 -0
  74. package/dist/assets/geistcn/icons/named/icon-chevron-up.d.ts.map +1 -0
  75. package/dist/assets/geistcn/icons/named/icon-chevron-up.js +25 -0
  76. package/dist/assets/geistcn/icons/named/icon-circle.d.ts +26 -0
  77. package/dist/assets/geistcn/icons/named/icon-circle.d.ts.map +1 -0
  78. package/dist/assets/geistcn/icons/named/icon-circle.js +26 -0
  79. package/dist/assets/geistcn/icons/named/icon-copy.d.ts +26 -0
  80. package/dist/assets/geistcn/icons/named/icon-copy.d.ts.map +1 -0
  81. package/dist/assets/geistcn/icons/named/icon-copy.js +25 -0
  82. package/dist/assets/geistcn/icons/named/icon-credit-card.d.ts +26 -0
  83. package/dist/assets/geistcn/icons/named/icon-credit-card.d.ts.map +1 -0
  84. package/dist/assets/geistcn/icons/named/icon-credit-card.js +25 -0
  85. package/dist/assets/geistcn/icons/named/icon-cross.d.ts +26 -0
  86. package/dist/assets/geistcn/icons/named/icon-cross.d.ts.map +1 -0
  87. package/dist/assets/geistcn/icons/named/icon-cross.js +25 -0
  88. package/dist/assets/geistcn/icons/named/icon-device-desktop.d.ts +26 -0
  89. package/dist/assets/geistcn/icons/named/icon-device-desktop.d.ts.map +1 -0
  90. package/dist/assets/geistcn/icons/named/icon-device-desktop.js +25 -0
  91. package/dist/assets/geistcn/icons/named/icon-external.d.ts +26 -0
  92. package/dist/assets/geistcn/icons/named/icon-external.d.ts.map +1 -0
  93. package/dist/assets/geistcn/icons/named/icon-external.js +25 -0
  94. package/dist/assets/geistcn/icons/named/icon-file-text.d.ts +26 -0
  95. package/dist/assets/geistcn/icons/named/icon-file-text.d.ts.map +1 -0
  96. package/dist/assets/geistcn/icons/named/icon-file-text.js +25 -0
  97. package/dist/assets/geistcn/icons/named/icon-file.d.ts +26 -0
  98. package/dist/assets/geistcn/icons/named/icon-file.d.ts.map +1 -0
  99. package/dist/assets/geistcn/icons/named/icon-file.js +25 -0
  100. package/dist/assets/geistcn/icons/named/icon-fluid.d.ts +26 -0
  101. package/dist/assets/geistcn/icons/named/icon-fluid.d.ts.map +1 -0
  102. package/dist/assets/geistcn/icons/named/icon-fluid.js +25 -0
  103. package/dist/assets/geistcn/icons/named/icon-information.d.ts +26 -0
  104. package/dist/assets/geistcn/icons/named/icon-information.d.ts.map +1 -0
  105. package/dist/assets/geistcn/icons/named/icon-information.js +26 -0
  106. package/dist/assets/geistcn/icons/named/icon-languages.d.ts +26 -0
  107. package/dist/assets/geistcn/icons/named/icon-languages.d.ts.map +1 -0
  108. package/dist/assets/geistcn/icons/named/icon-languages.js +25 -0
  109. package/dist/assets/geistcn/icons/named/icon-link.d.ts +26 -0
  110. package/dist/assets/geistcn/icons/named/icon-link.d.ts.map +1 -0
  111. package/dist/assets/geistcn/icons/named/icon-link.js +25 -0
  112. package/dist/assets/geistcn/icons/named/icon-menu-alt.d.ts +26 -0
  113. package/dist/assets/geistcn/icons/named/icon-menu-alt.d.ts.map +1 -0
  114. package/dist/assets/geistcn/icons/named/icon-menu-alt.js +25 -0
  115. package/dist/assets/geistcn/icons/named/icon-message.d.ts +26 -0
  116. package/dist/assets/geistcn/icons/named/icon-message.d.ts.map +1 -0
  117. package/dist/assets/geistcn/icons/named/icon-message.js +25 -0
  118. package/dist/assets/geistcn/icons/named/icon-moon.d.ts +26 -0
  119. package/dist/assets/geistcn/icons/named/icon-moon.d.ts.map +1 -0
  120. package/dist/assets/geistcn/icons/named/icon-moon.js +25 -0
  121. package/dist/assets/geistcn/icons/named/icon-rss.d.ts +26 -0
  122. package/dist/assets/geistcn/icons/named/icon-rss.d.ts.map +1 -0
  123. package/dist/assets/geistcn/icons/named/icon-rss.js +25 -0
  124. package/dist/assets/geistcn/icons/named/icon-slash-forward.d.ts +26 -0
  125. package/dist/assets/geistcn/icons/named/icon-slash-forward.d.ts.map +1 -0
  126. package/dist/assets/geistcn/icons/named/icon-slash-forward.js +25 -0
  127. package/dist/assets/geistcn/icons/named/icon-stop-circle.d.ts +26 -0
  128. package/dist/assets/geistcn/icons/named/icon-stop-circle.d.ts.map +1 -0
  129. package/dist/assets/geistcn/icons/named/icon-stop-circle.js +26 -0
  130. package/dist/assets/geistcn/icons/named/icon-sun.d.ts +26 -0
  131. package/dist/assets/geistcn/icons/named/icon-sun.d.ts.map +1 -0
  132. package/dist/assets/geistcn/icons/named/icon-sun.js +25 -0
  133. package/dist/assets/geistcn/icons/named/icon-terminal.d.ts +26 -0
  134. package/dist/assets/geistcn/icons/named/icon-terminal.d.ts.map +1 -0
  135. package/dist/assets/geistcn/icons/named/icon-terminal.js +25 -0
  136. package/dist/assets/geistcn/icons/named/icon-thumb-up.d.ts +26 -0
  137. package/dist/assets/geistcn/icons/named/icon-thumb-up.d.ts.map +1 -0
  138. package/dist/assets/geistcn/icons/named/icon-thumb-up.js +25 -0
  139. package/dist/assets/geistcn/icons/named/icon-trash.d.ts +26 -0
  140. package/dist/assets/geistcn/icons/named/icon-trash.d.ts.map +1 -0
  141. package/dist/assets/geistcn/icons/named/icon-trash.js +25 -0
  142. package/dist/assets/geistcn/logos/named/logo-eve-svg.d.ts +35 -0
  143. package/dist/assets/geistcn/logos/named/logo-eve-svg.d.ts.map +1 -0
  144. package/dist/assets/geistcn/logos/named/logo-eve-svg.js +37 -0
  145. package/dist/assets/geistcn/logos/named/logo-icon-github-svg.d.ts +27 -0
  146. package/dist/assets/geistcn/logos/named/logo-icon-github-svg.d.ts.map +1 -0
  147. package/dist/assets/geistcn/logos/named/logo-icon-github-svg.js +27 -0
  148. package/dist/assets/geistcn/logos/named/logo-icon-v0-svg.d.ts +27 -0
  149. package/dist/assets/geistcn/logos/named/logo-icon-v0-svg.d.ts.map +1 -0
  150. package/dist/assets/geistcn/logos/named/logo-icon-v0-svg.js +26 -0
  151. package/dist/assets/geistcn/logos/named/logo-icon-vercel-fill-svg.d.ts +27 -0
  152. package/dist/assets/geistcn/logos/named/logo-icon-vercel-fill-svg.d.ts.map +1 -0
  153. package/dist/assets/geistcn/logos/named/logo-icon-vercel-fill-svg.js +26 -0
  154. package/dist/assets/geistcn/logos/named/logo-icon-vercel-svg.d.ts +27 -0
  155. package/dist/assets/geistcn/logos/named/logo-icon-vercel-svg.d.ts.map +1 -0
  156. package/dist/assets/geistcn/logos/named/logo-icon-vercel-svg.js +26 -0
  157. package/dist/assets/geistcn/logos/named/logo-next-js-svg.d.ts +35 -0
  158. package/dist/assets/geistcn/logos/named/logo-next-js-svg.d.ts.map +1 -0
  159. package/dist/assets/geistcn/logos/named/logo-next-js-svg.js +37 -0
  160. package/dist/assets/geistcn/logos/named/logo-svelte-svg.d.ts +35 -0
  161. package/dist/assets/geistcn/logos/named/logo-svelte-svg.d.ts.map +1 -0
  162. package/dist/assets/geistcn/logos/named/logo-svelte-svg.js +37 -0
  163. package/dist/assets/geistcn/logos/named/logo-vercel-oss-svg.d.ts +35 -0
  164. package/dist/assets/geistcn/logos/named/logo-vercel-oss-svg.d.ts.map +1 -0
  165. package/dist/assets/geistcn/logos/named/logo-vercel-oss-svg.js +37 -0
  166. package/dist/assets/icons/index.d.ts +1 -4
  167. package/dist/assets/icons/index.d.ts.map +1 -1
  168. package/dist/assets/icons/index.js +1 -4
  169. package/dist/assets/logos/index.d.ts +1 -4
  170. package/dist/assets/logos/index.d.ts.map +1 -1
  171. package/dist/assets/logos/index.js +1 -4
  172. package/dist/cli/index.js +5 -5
  173. package/dist/components/blockquote.d.ts +3 -0
  174. package/dist/components/blockquote.d.ts.map +1 -0
  175. package/dist/components/blockquote.js +3 -0
  176. package/dist/components/callout.d.ts +13 -10
  177. package/dist/components/callout.d.ts.map +1 -1
  178. package/dist/components/callout.js +7 -7
  179. package/dist/components/code-block-tabs.d.ts +5 -2
  180. package/dist/components/code-block-tabs.d.ts.map +1 -1
  181. package/dist/components/code-block-tabs.js +30 -5
  182. package/dist/components/code-block.d.ts +2 -6
  183. package/dist/components/code-block.d.ts.map +1 -1
  184. package/dist/components/code-block.js +22 -68
  185. package/dist/components/command-prompt.d.ts.map +1 -1
  186. package/dist/components/command-prompt.js +18 -25
  187. package/dist/components/copy-prompt.d.ts +2 -1
  188. package/dist/components/copy-prompt.d.ts.map +1 -1
  189. package/dist/components/copy-prompt.js +5 -5
  190. package/dist/components/heading.d.ts +7 -0
  191. package/dist/components/heading.d.ts.map +1 -0
  192. package/dist/components/heading.js +14 -0
  193. package/dist/components/image.d.ts +19 -0
  194. package/dist/components/image.d.ts.map +1 -0
  195. package/dist/components/image.js +9 -0
  196. package/dist/components/mermaid.js +1 -1
  197. package/dist/components/steps.d.ts +9 -0
  198. package/dist/components/steps.d.ts.map +1 -0
  199. package/dist/components/steps.js +9 -0
  200. package/dist/components/table.d.ts +3 -0
  201. package/dist/components/table.d.ts.map +1 -0
  202. package/dist/components/table.js +3 -0
  203. package/dist/controls.d.ts +8 -4
  204. package/dist/controls.d.ts.map +1 -1
  205. package/dist/controls.js +16 -15
  206. package/dist/footer.d.ts.map +1 -1
  207. package/dist/footer.js +6 -6
  208. package/dist/internal/changelog-entries.d.ts.map +1 -1
  209. package/dist/internal/changelog-entries.js +3 -3
  210. package/dist/internal/chat/activity.d.ts +20 -0
  211. package/dist/internal/chat/activity.d.ts.map +1 -0
  212. package/dist/internal/chat/activity.js +43 -0
  213. package/dist/internal/chat/context.d.ts +2 -0
  214. package/dist/internal/chat/context.d.ts.map +1 -1
  215. package/dist/internal/chat/context.js +24 -3
  216. package/dist/internal/chat/conversation.d.ts +4 -3
  217. package/dist/internal/chat/conversation.d.ts.map +1 -1
  218. package/dist/internal/chat/conversation.js +5 -5
  219. package/dist/internal/chat/copy-chat.d.ts.map +1 -1
  220. package/dist/internal/chat/copy-chat.js +13 -10
  221. package/dist/internal/chat/dots-spinner.d.ts +5 -0
  222. package/dist/internal/chat/dots-spinner.d.ts.map +1 -0
  223. package/dist/internal/chat/dots-spinner.js +21 -0
  224. package/dist/internal/chat/loading-skeleton.d.ts +7 -0
  225. package/dist/internal/chat/loading-skeleton.d.ts.map +1 -0
  226. package/dist/internal/chat/loading-skeleton.js +46 -0
  227. package/dist/internal/chat/message-metadata.d.ts.map +1 -1
  228. package/dist/internal/chat/message-metadata.js +18 -32
  229. package/dist/internal/chat/message-sources.d.ts +3 -0
  230. package/dist/internal/chat/message-sources.d.ts.map +1 -0
  231. package/dist/internal/chat/message-sources.js +23 -0
  232. package/dist/internal/chat/message.d.ts.map +1 -1
  233. package/dist/internal/chat/message.js +62 -8
  234. package/dist/internal/chat/prompt-input.d.ts +1 -1
  235. package/dist/internal/chat/prompt-input.d.ts.map +1 -1
  236. package/dist/internal/chat/prompt-input.js +25 -27
  237. package/dist/internal/chat/shell.d.ts.map +1 -1
  238. package/dist/internal/chat/shell.js +43 -46
  239. package/dist/internal/chat/source-chunks.d.ts +9 -0
  240. package/dist/internal/chat/source-chunks.d.ts.map +1 -0
  241. package/dist/internal/chat/source-chunks.js +7 -0
  242. package/dist/internal/chat/sources.d.ts +4 -2
  243. package/dist/internal/chat/sources.d.ts.map +1 -1
  244. package/dist/internal/chat/sources.js +12 -6
  245. package/dist/internal/chat/suggestion.d.ts +11 -6
  246. package/dist/internal/chat/suggestion.d.ts.map +1 -1
  247. package/dist/internal/chat/suggestion.js +5 -5
  248. package/dist/internal/docs-page-error-boundary.js +3 -3
  249. package/dist/internal/external-arrow.js +1 -1
  250. package/dist/internal/footer/rss-button.d.ts.map +1 -1
  251. package/dist/internal/footer/rss-button.js +3 -3
  252. package/dist/internal/github-button.d.ts.map +1 -1
  253. package/dist/internal/github-button.js +3 -3
  254. package/dist/internal/link-href.d.ts +13 -0
  255. package/dist/internal/link-href.d.ts.map +1 -0
  256. package/dist/internal/link-href.js +51 -0
  257. package/dist/internal/mdx-to-markdown.d.ts +3 -0
  258. package/dist/internal/mdx-to-markdown.d.ts.map +1 -0
  259. package/dist/internal/mdx-to-markdown.js +166 -0
  260. package/dist/internal/mousedown-navigation-utils.d.ts +5 -0
  261. package/dist/internal/mousedown-navigation-utils.d.ts.map +1 -0
  262. package/dist/internal/mousedown-navigation-utils.js +95 -0
  263. package/dist/internal/mousedown-navigation.d.ts +10 -0
  264. package/dist/internal/mousedown-navigation.d.ts.map +1 -0
  265. package/dist/internal/mousedown-navigation.js +42 -0
  266. package/dist/internal/navbar/desktop-menu.d.ts.map +1 -1
  267. package/dist/internal/navbar/desktop-menu.js +3 -3
  268. package/dist/internal/navbar/mobile-menu.d.ts.map +1 -1
  269. package/dist/internal/navbar/mobile-menu.js +11 -16
  270. package/dist/internal/navbar/navbar-logo.d.ts.map +1 -1
  271. package/dist/internal/navbar/navbar-logo.js +5 -7
  272. package/dist/internal/navbar/navbar-shell.d.ts.map +1 -1
  273. package/dist/internal/navbar/navbar-shell.js +3 -2
  274. package/dist/internal/page-actions-client.d.ts.map +1 -1
  275. package/dist/internal/page-actions-client.js +51 -30
  276. package/dist/internal/page-breadcrumb.js +3 -3
  277. package/dist/internal/page-footer.js +2 -2
  278. package/dist/internal/provider-client.d.ts.map +1 -1
  279. package/dist/internal/provider-client.js +36 -12
  280. package/dist/internal/react-node-text.d.ts +4 -0
  281. package/dist/internal/react-node-text.d.ts.map +1 -0
  282. package/dist/internal/react-node-text.js +11 -0
  283. package/dist/internal/search.d.ts.map +1 -1
  284. package/dist/internal/search.js +2 -2
  285. package/dist/internal/sidebar-responsive.d.ts +0 -1
  286. package/dist/internal/sidebar-responsive.d.ts.map +1 -1
  287. package/dist/internal/sidebar-responsive.js +0 -9
  288. package/dist/internal/sidebar-tree.d.ts.map +1 -1
  289. package/dist/internal/sidebar-tree.js +6 -1
  290. package/dist/internal/sidebar.d.ts.map +1 -1
  291. package/dist/internal/sidebar.js +80 -53
  292. package/dist/internal/table-of-contents.d.ts.map +1 -1
  293. package/dist/internal/table-of-contents.js +1 -1
  294. package/dist/internal/toc-items.d.ts.map +1 -1
  295. package/dist/internal/toc-items.js +19 -8
  296. package/dist/internal/ui/dropdown-menu.d.ts.map +1 -1
  297. package/dist/internal/ui/dropdown-menu.js +8 -8
  298. package/dist/internal/ui/navigation-menu.d.ts.map +1 -1
  299. package/dist/internal/ui/navigation-menu.js +4 -4
  300. package/dist/internal/ui/popover.js +1 -1
  301. package/dist/internal/ui/scroll-area.js +1 -1
  302. package/dist/internal/use-mobile.d.ts.map +1 -1
  303. package/dist/internal/use-mobile.js +2 -12
  304. package/dist/layout.d.ts +1 -0
  305. package/dist/layout.d.ts.map +1 -1
  306. package/dist/layout.js +2 -0
  307. package/dist/mdx.d.ts.map +1 -1
  308. package/dist/mdx.js +20 -2
  309. package/dist/mobile-docs-bar.d.ts.map +1 -1
  310. package/dist/mobile-docs-bar.js +1 -2
  311. package/dist/navbar.js +3 -2
  312. package/dist/pages/docs.d.ts.map +1 -1
  313. package/dist/pages/docs.js +18 -5
  314. package/dist/providers/public/components/badge.d.ts +8 -0
  315. package/dist/providers/public/components/badge.d.ts.map +1 -0
  316. package/dist/providers/public/components/badge.js +10 -0
  317. package/dist/providers/public/components/button.d.ts +18 -0
  318. package/dist/providers/public/components/button.d.ts.map +1 -0
  319. package/dist/providers/public/components/button.js +24 -0
  320. package/dist/providers/public/components/code-block-server.d.ts +11 -0
  321. package/dist/providers/public/components/code-block-server.d.ts.map +1 -0
  322. package/dist/providers/public/components/code-block-server.js +26 -0
  323. package/dist/providers/public/components/code-block.d.ts +10 -0
  324. package/dist/providers/public/components/code-block.d.ts.map +1 -0
  325. package/dist/providers/public/components/code-block.js +3 -0
  326. package/dist/providers/public/components/copy-button.d.ts +7 -0
  327. package/dist/providers/public/components/copy-button.d.ts.map +1 -0
  328. package/dist/providers/public/components/copy-button.js +23 -0
  329. package/dist/providers/public/components/drawer.d.ts +13 -0
  330. package/dist/providers/public/components/drawer.d.ts.map +1 -0
  331. package/dist/providers/public/components/drawer.js +10 -0
  332. package/dist/providers/public/components/image.d.ts +7 -0
  333. package/dist/providers/public/components/image.d.ts.map +1 -0
  334. package/dist/providers/public/components/image.js +4 -0
  335. package/dist/providers/public/components/kbd.d.ts +7 -0
  336. package/dist/providers/public/components/kbd.d.ts.map +1 -0
  337. package/dist/providers/public/components/kbd.js +10 -0
  338. package/dist/providers/public/components/modal.d.ts +22 -0
  339. package/dist/providers/public/components/modal.d.ts.map +1 -0
  340. package/dist/providers/public/components/modal.js +19 -0
  341. package/dist/{internal/ui → providers/public/components}/sheet.d.ts +2 -1
  342. package/dist/providers/public/components/sheet.d.ts.map +1 -0
  343. package/dist/{internal/ui → providers/public/components}/sheet.js +5 -5
  344. package/dist/providers/public/components/skeleton.d.ts +10 -0
  345. package/dist/providers/public/components/skeleton.d.ts.map +1 -0
  346. package/dist/providers/public/components/skeleton.js +3 -0
  347. package/dist/{internal/ui → providers/public/components}/spinner.d.ts +1 -1
  348. package/dist/providers/public/components/spinner.d.ts.map +1 -0
  349. package/dist/providers/public/components/spinner.js +11 -0
  350. package/dist/providers/public/components/textarea.d.ts.map +1 -0
  351. package/dist/{internal/ui → providers/public/components}/textarea.js +1 -1
  352. package/dist/providers/public/components/theme-switcher.d.ts.map +1 -0
  353. package/dist/{components → providers/public/components}/theme-switcher.js +7 -7
  354. package/dist/providers/public/components/toasts.d.ts +10 -0
  355. package/dist/providers/public/components/toasts.d.ts.map +1 -0
  356. package/dist/providers/public/components/toasts.js +8 -0
  357. package/dist/providers/public/components/tooltip.d.ts +13 -0
  358. package/dist/providers/public/components/tooltip.d.ts.map +1 -0
  359. package/dist/providers/public/components/tooltip.js +5 -0
  360. package/dist/providers/public/core/fonts.d.ts +2 -0
  361. package/dist/providers/public/core/fonts.d.ts.map +1 -0
  362. package/dist/providers/public/core/fonts.js +24 -0
  363. package/dist/providers/public/core/provider.d.ts +8 -0
  364. package/dist/providers/public/core/provider.d.ts.map +1 -0
  365. package/dist/providers/public/core/provider.js +4 -0
  366. package/dist/providers/public/core/theme-script.d.ts +5 -0
  367. package/dist/providers/public/core/theme-script.d.ts.map +1 -0
  368. package/dist/providers/public/core/theme-script.js +7 -0
  369. package/dist/providers/public/core.d.ts +5 -0
  370. package/dist/providers/public/core.d.ts.map +1 -0
  371. package/dist/providers/public/core.js +4 -0
  372. package/dist/{internal/cn.d.ts → providers/public/utils.d.ts} +1 -1
  373. package/dist/providers/public/utils.d.ts.map +1 -0
  374. package/dist/providers/public-assets/icons/icon-check.d.ts +2 -0
  375. package/dist/providers/public-assets/icons/icon-check.d.ts.map +1 -0
  376. package/dist/providers/public-assets/icons/icon-check.js +1 -0
  377. package/dist/providers/public-assets/icons/icon-chevron-down-small.d.ts +2 -0
  378. package/dist/providers/public-assets/icons/icon-chevron-down-small.d.ts.map +1 -0
  379. package/dist/providers/public-assets/icons/icon-chevron-down-small.js +1 -0
  380. package/dist/providers/public-assets/icons/icon-copy.d.ts +2 -0
  381. package/dist/providers/public-assets/icons/icon-copy.d.ts.map +1 -0
  382. package/dist/providers/public-assets/icons/icon-copy.js +1 -0
  383. package/dist/providers/public-assets/icons.d.ts +40 -0
  384. package/dist/providers/public-assets/icons.d.ts.map +1 -0
  385. package/dist/providers/public-assets/icons.js +39 -0
  386. package/dist/providers/public-assets/logos.d.ts +9 -0
  387. package/dist/providers/public-assets/logos.d.ts.map +1 -0
  388. package/dist/providers/public-assets/logos.js +8 -0
  389. package/dist/routes/chat.d.ts +1 -1
  390. package/dist/routes/chat.d.ts.map +1 -1
  391. package/dist/routes/chat.js +31 -14
  392. package/dist/routes/llms.d.ts +1 -1
  393. package/dist/routes/llms.d.ts.map +1 -1
  394. package/dist/routes/llms.js +12 -2
  395. package/dist/source-config.d.ts +10 -0
  396. package/dist/source-config.d.ts.map +1 -1
  397. package/dist/source-config.js +20 -2
  398. package/dist/source.d.ts +10 -1
  399. package/dist/source.d.ts.map +1 -1
  400. package/dist/source.js +75 -36
  401. package/dist/versions.d.ts.map +1 -1
  402. package/dist/versions.js +5 -5
  403. package/docs/agents.md +5 -4
  404. package/docs/llms.txt +512 -138
  405. package/docs/manifest.json +21 -12
  406. package/docs/pages/ask-ai.md +3 -4
  407. package/docs/pages/components/steps.md +129 -0
  408. package/docs/pages/deployment.md +6 -3
  409. package/docs/pages/getting-started.md +23 -29
  410. package/docs/pages/guides/nested-navigation.md +1 -1
  411. package/docs/pages/md.md +24 -5
  412. package/docs/pages/migration.md +11 -15
  413. package/docs/pages/packages.md +54 -0
  414. package/docs/pages/syntax.md +246 -11
  415. package/docs/pages/versioned-docs.md +2 -3
  416. package/docs/sitemap.md +4 -3
  417. package/package.json +36 -90
  418. package/public-foundation.css +681 -0
  419. package/shared-theme.css +349 -0
  420. package/source-config.js +37 -2
  421. package/styles.css +1 -2
  422. package/template/AGENTS.md +15 -6
  423. package/template/app/[lang]/(home)/components/cta.tsx +8 -3
  424. package/template/app/[lang]/(home)/components/hero.tsx +1 -1
  425. package/template/app/[lang]/(home)/components/one-two-section.tsx +9 -1
  426. package/template/app/[lang]/(home)/components/text-grid-section.tsx +1 -1
  427. package/template/app/[lang]/(home)/page.tsx +5 -6
  428. package/template/app/[lang]/layout.tsx +11 -4
  429. package/template/app/styles/geistdocs.css +13 -18
  430. package/template/components.json +0 -1
  431. package/template/content/docs/ask-ai.cn.mdx +2 -2
  432. package/template/content/docs/ask-ai.mdx +3 -4
  433. package/template/content/docs/components/meta.json +4 -0
  434. package/template/content/docs/components/steps.mdx +125 -0
  435. package/template/content/docs/configuration.cn.mdx +1 -3
  436. package/template/content/docs/deployment.mdx +8 -4
  437. package/template/content/docs/getting-started.mdx +24 -30
  438. package/template/content/docs/guides/nested-navigation.mdx +1 -1
  439. package/template/content/docs/md.mdx +24 -5
  440. package/template/content/docs/meta.json +3 -0
  441. package/template/content/docs/migration.mdx +12 -16
  442. package/template/content/docs/packages.mdx +53 -0
  443. package/template/content/docs/syntax.mdx +252 -11
  444. package/template/content/docs/versioned-docs.mdx +2 -3
  445. package/template/next.config.ts +9 -1
  446. package/template/package.json +2 -8
  447. package/theme.css +2 -955
  448. package/dist/components/badge.d.ts +0 -11
  449. package/dist/components/badge.d.ts.map +0 -1
  450. package/dist/components/badge.js +0 -22
  451. package/dist/components/button-group.d.ts +0 -2
  452. package/dist/components/button-group.d.ts.map +0 -1
  453. package/dist/components/button-group.js +0 -2
  454. package/dist/components/button.d.ts +0 -2
  455. package/dist/components/button.d.ts.map +0 -1
  456. package/dist/components/button.js +0 -2
  457. package/dist/components/card.d.ts +0 -2
  458. package/dist/components/card.d.ts.map +0 -1
  459. package/dist/components/card.js +0 -2
  460. package/dist/components/dialog.d.ts +0 -13
  461. package/dist/components/dialog.d.ts.map +0 -1
  462. package/dist/components/dialog.js +0 -35
  463. package/dist/components/drawer.d.ts +0 -2
  464. package/dist/components/drawer.d.ts.map +0 -1
  465. package/dist/components/drawer.js +0 -3
  466. package/dist/components/input-group.d.ts +0 -2
  467. package/dist/components/input-group.d.ts.map +0 -1
  468. package/dist/components/input-group.js +0 -3
  469. package/dist/components/input.d.ts +0 -2
  470. package/dist/components/input.d.ts.map +0 -1
  471. package/dist/components/input.js +0 -2
  472. package/dist/components/kbd.d.ts +0 -2
  473. package/dist/components/kbd.d.ts.map +0 -1
  474. package/dist/components/kbd.js +0 -2
  475. package/dist/components/separator.d.ts +0 -2
  476. package/dist/components/separator.d.ts.map +0 -1
  477. package/dist/components/separator.js +0 -3
  478. package/dist/components/sheet.d.ts +0 -2
  479. package/dist/components/sheet.d.ts.map +0 -1
  480. package/dist/components/sheet.js +0 -3
  481. package/dist/components/sonner.d.ts +0 -2
  482. package/dist/components/sonner.d.ts.map +0 -1
  483. package/dist/components/sonner.js +0 -3
  484. package/dist/components/spinner.d.ts +0 -2
  485. package/dist/components/spinner.d.ts.map +0 -1
  486. package/dist/components/spinner.js +0 -2
  487. package/dist/components/switch.d.ts +0 -11
  488. package/dist/components/switch.d.ts.map +0 -1
  489. package/dist/components/switch.js +0 -12
  490. package/dist/components/textarea.d.ts +0 -2
  491. package/dist/components/textarea.d.ts.map +0 -1
  492. package/dist/components/textarea.js +0 -2
  493. package/dist/components/theme-aware-image.d.ts +0 -12
  494. package/dist/components/theme-aware-image.d.ts.map +0 -1
  495. package/dist/components/theme-aware-image.js +0 -8
  496. package/dist/components/theme-switcher.d.ts.map +0 -1
  497. package/dist/components/tooltip.d.ts +0 -2
  498. package/dist/components/tooltip.d.ts.map +0 -1
  499. package/dist/components/tooltip.js +0 -3
  500. package/dist/internal/chat/shimmer.d.ts +0 -11
  501. package/dist/internal/chat/shimmer.d.ts.map +0 -1
  502. package/dist/internal/chat/shimmer.js +0 -22
  503. package/dist/internal/cn.d.ts.map +0 -1
  504. package/dist/internal/ui/button-group.d.ts +0 -13
  505. package/dist/internal/ui/button-group.d.ts.map +0 -1
  506. package/dist/internal/ui/button-group.js +0 -26
  507. package/dist/internal/ui/button.d.ts +0 -12
  508. package/dist/internal/ui/button.d.ts.map +0 -1
  509. package/dist/internal/ui/button.js +0 -33
  510. package/dist/internal/ui/card.d.ts +0 -6
  511. package/dist/internal/ui/card.d.ts.map +0 -1
  512. package/dist/internal/ui/card.js +0 -14
  513. package/dist/internal/ui/drawer.d.ts +0 -8
  514. package/dist/internal/ui/drawer.d.ts.map +0 -1
  515. package/dist/internal/ui/drawer.js +0 -19
  516. package/dist/internal/ui/input-group.d.ts +0 -15
  517. package/dist/internal/ui/input-group.d.ts.map +0 -1
  518. package/dist/internal/ui/input-group.js +0 -44
  519. package/dist/internal/ui/input.d.ts +0 -3
  520. package/dist/internal/ui/input.d.ts.map +0 -1
  521. package/dist/internal/ui/input.js +0 -5
  522. package/dist/internal/ui/kbd.d.ts +0 -4
  523. package/dist/internal/ui/kbd.d.ts.map +0 -1
  524. package/dist/internal/ui/kbd.js +0 -8
  525. package/dist/internal/ui/separator.d.ts +0 -4
  526. package/dist/internal/ui/separator.d.ts.map +0 -1
  527. package/dist/internal/ui/separator.js +0 -7
  528. package/dist/internal/ui/sheet.d.ts.map +0 -1
  529. package/dist/internal/ui/sonner.d.ts +0 -3
  530. package/dist/internal/ui/sonner.d.ts.map +0 -1
  531. package/dist/internal/ui/sonner.js +0 -20
  532. package/dist/internal/ui/spinner.d.ts.map +0 -1
  533. package/dist/internal/ui/spinner.js +0 -6
  534. package/dist/internal/ui/textarea.d.ts.map +0 -1
  535. package/dist/internal/ui/tooltip.d.ts +0 -7
  536. package/dist/internal/ui/tooltip.d.ts.map +0 -1
  537. package/dist/internal/ui/tooltip.js +0 -16
  538. package/docs/pages/theme-aware-image.md +0 -59
  539. package/template/app/[lang]/(home)/components/centered-section.tsx +0 -32
  540. package/template/components/ui/button.tsx +0 -60
  541. package/template/content/docs/theme-aware-image.mdx +0 -57
  542. /package/dist/{internal/ui → providers/public/components}/textarea.d.ts +0 -0
  543. /package/dist/{components → providers/public/components}/theme-switcher.d.ts +0 -0
  544. /package/dist/{internal/cn.js → providers/public/utils.js} +0 -0
@@ -78,8 +78,8 @@ The chat interface adapts to different screen sizes:
78
78
 
79
79
  The environment variables `AI_GATEWAY_API_KEY` and `NEXT_PUBLIC_VERCEL_PROJECT_PRODUCTION_URL` must be set, which you can read more about in the [环境变量](/docs/env) section.
80
80
 
81
- The model used is `openai/gpt-4.1-mini` via the Vercel AI Gateway.
81
+ The model used is `openai/gpt-5.6-sol` via the Vercel AI Gateway.
82
82
 
83
83
  ## 建议的提示
84
84
 
85
- 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 [配置](/docs/configuration) section.
85
+ 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 [配置](/docs/configuration) section.
@@ -40,7 +40,6 @@ Users can open the chat interface at any time by:
40
40
  Once open, users can:
41
41
 
42
42
  - Ask questions about any part of your documentation
43
- - Expand the desktop panel to a full-screen view for wide responses and code blocks
44
43
  - Upload files or images for context
45
44
  - View AI-powered search results from your docs
46
45
  - Get step-by-step guidance on complex topics
@@ -93,7 +92,7 @@ In this mode, Geistdocs uses the local `search_docs` tool during the AI SDK `str
93
92
 
94
93
  #### Choose a model
95
94
 
96
- Pass the `model` option to `createChatRoute` to control which model answers Ask AI requests. It accepts any AI SDK `LanguageModel`, including AI Gateway model strings, and defaults to `openai/gpt-4.1-mini`.
95
+ Pass the `model` option to `createChatRoute` to control which model answers Ask AI requests. It accepts any AI SDK `LanguageModel`, including AI Gateway model strings, and defaults to `openai/gpt-5.6-sol`.
97
96
 
98
97
  ```ts title="app/api/chat/route.ts"
99
98
  import { createChatRoute } from "@vercel/geistdocs/routes/chat";
@@ -197,14 +196,14 @@ Conversations are automatically saved to the browser's IndexedDB, providing:
197
196
 
198
197
  The chat interface adapts to different screen sizes:
199
198
 
200
- - **Desktop**: Slides in from the right side as a sidebar panel. Use **Expand chat** in the panel header to switch to a full-screen view, and **Collapse chat** or `Escape` to return to the sidebar.
199
+ - **Desktop**: Slides in from the right side as a sidebar panel
201
200
  - **Mobile**: Opens as a bottom drawer.
202
201
 
203
202
  ## Configuration
204
203
 
205
204
  The environment variables `AI_GATEWAY_API_KEY` and `NEXT_PUBLIC_VERCEL_PROJECT_PRODUCTION_URL` must be set for the default AI Gateway mode. Set `GEISTDOCS_CHAT_PROXY_URL` to route Ask AI through a Vertex-backed proxy instead. You can read more in the [Environment Variables](/docs/env) section.
206
205
 
207
- In default AI Gateway mode, Geistdocs uses `openai/gpt-4.1-mini` via the Vercel AI Gateway. In Vertex-backed proxy mode, the configured proxy controls the upstream model.
206
+ In default AI Gateway mode, Geistdocs uses `openai/gpt-5.6-sol` via the Vercel AI Gateway. In Vertex-backed proxy mode, the configured proxy controls the upstream model.
208
207
 
209
208
  ## Suggested Prompts
210
209
 
@@ -0,0 +1,4 @@
1
+ {
2
+ "title": "Components",
3
+ "pages": ["steps"]
4
+ }
@@ -0,0 +1,125 @@
1
+ ---
2
+ title: Steps
3
+ description: Render numbered step-by-step instructions from Markdown headings or the Steps and Step components
4
+ type: reference
5
+ summary: Write consecutive headings that start with a number, such as "### 1. Install", to render a numbered step list. The Steps and Step components cover cases where a heading must be wrapped in another component.
6
+ prerequisites:
7
+ - /docs/syntax
8
+ related:
9
+ - /docs/syntax
10
+ - /docs/table-of-contents
11
+ ---
12
+
13
+ Steps render sequential instructions as a numbered list with a counter beside each step heading. You write them as plain Markdown headings, so a page needs no imports and stays readable in Markdown output.
14
+
15
+ ## Write steps as numbered headings
16
+
17
+ Start each step heading with a number, a period, and a space. Consecutive headings at the same depth that follow this pattern become one step list.
18
+
19
+ ````md
20
+ ## Deploy the project
21
+
22
+ ### 1. Install the CLI
23
+
24
+ Install the Vercel CLI globally.
25
+
26
+ ```bash
27
+ pnpm add -g vercel
28
+ ```
29
+
30
+ ### 2. Link the project
31
+
32
+ Run `vercel link` in the project directory and pick the team and project.
33
+
34
+ ### 3. Deploy
35
+
36
+ Run `vercel deploy` to create a preview deployment.
37
+
38
+ ## Next section
39
+ ````
40
+
41
+ This renders as:
42
+
43
+ ### 1. Install the CLI
44
+
45
+ Install the Vercel CLI globally.
46
+
47
+ ```bash
48
+ pnpm add -g vercel
49
+ ```
50
+
51
+ ### 2. Link the project
52
+
53
+ Run `vercel link` in the project directory and pick the team and project.
54
+
55
+ ### 3. Deploy
56
+
57
+ Run `vercel deploy` to create a preview deployment.
58
+
59
+ ## How numbering and anchors work
60
+
61
+ Geistdocs removes the `1. ` prefix from the heading text at build time and draws the number with a CSS counter. As a result:
62
+
63
+ - The table of contents shows `Install the CLI`, not `1. Install the CLI`.
64
+ - The heading anchor is `#install-the-cli`, so renumbering steps does not break links.
65
+ - Custom anchors written as `### 1. Install the CLI [#install]` keep working.
66
+ - Markdown routes and `llms.txt` output numbered headings, such as `### 1. Install the CLI`, which read naturally for agents.
67
+
68
+ The numbers you write are only used to detect steps. Geistdocs always counts from 1, so `### 4. Deploy` at the start of a list renders as step 1.
69
+
70
+ ## Rules for grouping steps
71
+
72
+ Geistdocs groups headings into a step list using these rules:
73
+
74
+ | Situation | Result |
75
+ | --- | --- |
76
+ | Consecutive numbered headings at the same depth | One step list |
77
+ | A deeper heading inside a step, such as `#### Options` under `### 2. Configure` | Part of the current step |
78
+ | A heading at the same or shallower depth without a number prefix | Ends the step list |
79
+ | A numbered heading where inline code or a link immediately follows the number, such as `` ### 1. `vercel login` `` | Not detected as a step; move a word before the code, such as `` ### 1. Run `vercel login` `` |
80
+
81
+ Paragraphs, lists, code blocks, callouts, and images between two step headings belong to the earlier step.
82
+
83
+ ## Use the Steps and Step components
84
+
85
+ Use the components when a step heading has to be wrapped in another component, for example a framework switcher, and the heading pattern cannot be detected. Both components are in the default MDX component map and are exported from the selected package's `components/steps` subpath.
86
+
87
+ ```mdx
88
+ <Steps>
89
+ <Step>
90
+ ### Install the package
91
+
92
+ Run the install command for your package manager.
93
+ </Step>
94
+ <Step>
95
+ ### Configure the project
96
+
97
+ Add the configuration file to the project root.
98
+ </Step>
99
+ </Steps>
100
+ ```
101
+
102
+ This renders as:
103
+
104
+ <Steps>
105
+ <Step>
106
+ ### Install the package
107
+
108
+ Run the install command for your package manager.
109
+ </Step>
110
+ <Step>
111
+ ### Configure the project
112
+
113
+ Add the configuration file to the project root.
114
+ </Step>
115
+ </Steps>
116
+
117
+ Do not add a number prefix to headings inside `Step`. The component draws the counter, and a prefix would create a nested step list.
118
+
119
+ ### Props
120
+
121
+ `Steps` and `Step` accept the standard `div` attributes. Both forward `className`, which is merged with the `fd-steps` and `fd-step` classes that carry the counter styling.
122
+
123
+ ## Markdown output
124
+
125
+ In `.md` routes and `llms.txt`, each step list becomes plain numbered headings, such as `### 1. Install the CLI`, followed by the step content. This applies to steps written as headings and to steps written with `Steps` and `Step`, so agents read the same sequence without the wrapper markup.
@@ -31,11 +31,9 @@ related:
31
31
  项目根目录下的 `geistdocs.tsx` 文件包含主要自定义选项:
32
32
 
33
33
  ```tsx title="geistdocs.tsx"
34
- import { BookHeartIcon } from "lucide-react";
35
-
36
34
  export const Logo = () => (
37
35
  <div className="flex items-center gap-2">
38
- <BookHeartIcon className="size-5" />
36
+ <span aria-hidden className="grid size-5 place-items-center rounded bg-gray-100 text-label-12">G</span>
39
37
  <p className="font-semibold text-xl tracking-tight">Geistdocs</p>
40
38
  </div>
41
39
  );
@@ -2,7 +2,7 @@
2
2
  title: Deploy to Vercel
3
3
  description: Learn how to deploy your Geistdocs site to Vercel
4
4
  type: guide
5
- summary: Deploy a Geistdocs site to Vercel with the required project settings, environment variables, and private-package access.
5
+ summary: Deploy a Geistdocs site to Vercel with the required project settings and environment variables.
6
6
  prerequisites:
7
7
  - /docs/getting-started
8
8
  - /docs/env
@@ -10,12 +10,16 @@ related:
10
10
  - /docs/configuration
11
11
  ---
12
12
 
13
- Deploy a Geistdocs site to Vercel as a Next.js app. Configure package access, environment variables, and the production URL before shipping.
13
+ Deploy a Geistdocs site to Vercel as a Next.js app. Configure environment variables and the production URL before shipping. Public `@vercel/geistdocs` projects require no private npm access.
14
14
 
15
- <CopyPrompt text="Help me deploy this Geistdocs project to Vercel. Check whether it uses the Geistcn canary and therefore needs private npm access, then review the package scripts, environment variables, GitHub Actions authentication, and Vercel project settings.">
16
- Help me deploy this Geistdocs project to Vercel. Check whether it uses the Geistcn canary and therefore needs private npm access, then review the package scripts, environment variables, GitHub Actions authentication, and Vercel project settings.
15
+ <CopyPrompt text="Help me deploy this Geistdocs project to Vercel. Review the selected Geistdocs package, package scripts, environment variables, GitHub Actions authentication, and Vercel project settings. Verify private npm access only if the project uses @vercel/geistdocs-private.">
16
+ Help me deploy this Geistdocs project to Vercel. Review the selected package, scripts, environment variables, GitHub Actions authentication, and Vercel project settings. Verify private npm access only for `@vercel/geistdocs-private`.
17
17
  </CopyPrompt>
18
18
 
19
+ <Callout title="Private package access">
20
+ `@vercel/geistdocs-private` depends on the restricted `@vercel/geistcn` and `@vercel/geistcn-assets` packages. Use it only in internal environments such as `front`, where installs and deployments already have access. Public repositories, including Vercel-owned OSS projects, should use `@vercel/geistdocs`.
21
+ </Callout>
22
+
19
23
  ## Prerequisites
20
24
 
21
25
  Before deploying, you need:
@@ -10,10 +10,10 @@ related:
10
10
  - /docs/deployment
11
11
  ---
12
12
 
13
- Create a Geistdocs site with the package CLI, then edit the generated content and configuration files. If you already have a Fumadocs or custom Geist docs site, read [Migration guide](/docs/migration) before moving route adapters and middleware behavior.
13
+ Create a new Geistdocs site with the package CLI, then customize its identity, content, and navigation. If you already have a documentation site, use [Migrate to Geistdocs](/docs/migration). Read [Choose a Geistdocs package](/docs/packages) before using the private package.
14
14
 
15
- <CopyPrompt text="Help me create a Geistdocs project. Use @vercel/geistdocs@latest for the stable release or @vercel/geistdocs@canary when I specifically need the Geistcn migration. Then run pnpm dev and explain which files I should edit first: geistdocs.tsx, content/docs, content/docs/meta.json, and components/geistdocs/mdx-components.tsx.">
16
- Help me create a Geistdocs project. Use `@vercel/geistdocs@latest` for the stable release or `@vercel/geistdocs@canary` when I specifically need the Geistcn migration. Then run `pnpm dev` and explain which files I should edit first: `geistdocs.tsx`, `content/docs`, `content/docs/meta.json`, and `components/geistdocs/mdx-components.tsx`.
15
+ <CopyPrompt text="Create a new Geistdocs project with pnpm dlx @vercel/geistdocs@latest init --name my-docs. Confirm Node.js 20.9 or later, pnpm, and Git are available first. Then run pnpm dev and help me customize geistdocs.tsx, content/docs/index.mdx, and content/docs/meta.json. Keep the generated route, source, UI provider, and Next.js integrations package-backed.">
16
+ Create a new Geistdocs project with `pnpm dlx @vercel/geistdocs@latest init --name my-docs`. Confirm the prerequisites, run `pnpm dev`, and help me customize `geistdocs.tsx`, `content/docs/index.mdx`, and `content/docs/meta.json`. Keep the generated integrations package-backed.
17
17
  </CopyPrompt>
18
18
 
19
19
  ## Prerequisites
@@ -24,25 +24,7 @@ Before you begin, install:
24
24
  - pnpm
25
25
  - Git
26
26
 
27
- The Geistdocs CLI always uses pnpm to install the generated project's dependencies. Running the CLI through `npx` does not remove the pnpm requirement.
28
-
29
- ## Choose a release channel
30
-
31
- Use `@vercel/geistdocs@latest` for the current stable package-backed release. Use `@vercel/geistdocs@canary` only when you need changes being evaluated on the `canary` branch, including the current Geistcn migration.
32
-
33
- The canary dist-tag can move several times in one day. The CLI resolves the tag once and writes that exact version to the generated `package.json`.
34
-
35
- ## Authenticate for the Geistcn canary
36
-
37
- The Geistcn canary depends on restricted `@vercel/geistcn` and `@vercel/geistcn-assets` packages. Configure npm authentication before running the canary CLI. Add this configuration to your user-level `~/.npmrc`:
38
-
39
- ```ini title="~/.npmrc"
40
- @vercel:registry=https://registry.npmjs.org/
41
- //registry.npmjs.org/:_authToken=${NPM_TOKEN}
42
- always-auth=true
43
- ```
44
-
45
- Set `NPM_TOKEN` from an approved internal source and keep its value out of files and Git. Stable Geistdocs does not currently require these restricted packages. Read [Deploy to Vercel](/docs/deployment) before configuring automated installs.
27
+ The CLI always uses pnpm to install the generated project's dependencies.
46
28
 
47
29
  ## Create a project
48
30
 
@@ -52,19 +34,13 @@ Run the Geistdocs CLI from an empty parent folder. For stable Geistdocs, run:
52
34
  pnpm dlx @vercel/geistdocs@latest init --name my-docs
53
35
  ```
54
36
 
55
- For the Geistcn canary, run:
56
-
57
- ```bash title="Terminal"
58
- pnpm dlx @vercel/geistdocs@canary init --name my-docs
59
- ```
60
-
61
37
  The CLI copies the template bundled in the package, rewrites the generated app to depend on the same `@vercel/geistdocs` version, installs dependencies, copies `.env.example` to `.env.local`, and initializes Git.
62
38
 
63
39
  ## Understand generated dependencies
64
40
 
65
- Generated projects include `@vercel/geistdocs`, `ai` v6, and `@ai-sdk/react` v3. Geistdocs uses those AI SDK packages for Ask AI, including the chat client transport and `createChatRoute` server behavior. Canary projects also declare the matching `@vercel/geistcn` and `@vercel/geistcn-assets` versions directly because generated application files import them.
41
+ Generated projects pin the resolved package version and include AI SDK v6 and `@ai-sdk/react` v3. The public package does not require private npm access. The template already configures styles, fonts, Cache Components, Partial Prefetching, source adapters, search, Ask AI, and agent-readable routes.
66
42
 
67
- Update Ask AI by updating `@vercel/geistdocs`, not by copying package chat internals into the app. If your project uses the AI SDK directly for separate product features, keep that code compatible with the app's installed AI SDK version; package-owned Ask AI does not need to match another consumer project's `ai` version.
43
+ Keep those integrations package-backed. Update Geistdocs instead of copying package internals into the app.
68
44
 
69
45
  ## Start the development server
70
46
 
@@ -77,6 +53,14 @@ pnpm dev
77
53
 
78
54
  Open `http://localhost:3000` in your browser.
79
55
 
56
+ Start with these files:
57
+
58
+ - `geistdocs.tsx` for the site title, logo, navigation, repository, and AI prompt.
59
+ - `content/docs/index.mdx` for the documentation overview.
60
+ - `content/docs/meta.json` for sidebar order and groups.
61
+
62
+ Only customize `components/geistdocs/*`, `lib/geistdocs/*`, or route adapters when the generated defaults do not fit your site.
63
+
80
64
  ## Edit your first page
81
65
 
82
66
  Docs live in `content/docs`. Edit the overview page:
@@ -134,3 +118,13 @@ pnpm exec geistdocs update
134
118
  ```
135
119
 
136
120
  Review and test dependency changes before committing.
121
+
122
+ ## Verify and deploy
123
+
124
+ Run a production build before publishing:
125
+
126
+ ```bash title="Terminal"
127
+ pnpm build
128
+ ```
129
+
130
+ Then follow [Deploy to Vercel](/docs/deployment), including environment-variable setup. Private-package access is required only for `@vercel/geistdocs-private`.
@@ -197,7 +197,7 @@ Geistdocs applies a color for each method:
197
197
  | `PUT`, `PATCH` | Amber |
198
198
  | `DEL`, `DELETE` | Red |
199
199
 
200
- Method matching is case-sensitive, so use uppercase labels. `DEL` and `DELETE` render the same red badge, so prefer `DEL` when you want a narrower badge. Any other label, such as `Beta`, keeps the default blue badge. Badge colors adapt to light and dark themes automatically.
200
+ Method matching is case-sensitive, so use uppercase labels. `DEL` and `DELETE` render the same red badge, so prefer `DEL` when you want a narrower badge. `New` renders as a low-contrast blue badge; other labels, such as `Beta`, use the default neutral badge. Badge colors adapt to light and dark themes automatically.
201
201
 
202
202
  ## Add links to the navigation
203
203
 
@@ -9,7 +9,7 @@ related:
9
9
  - /docs/proxy
10
10
  ---
11
11
 
12
- Geistdocs lets AI tools and language models access documentation pages as plain Markdown. Append `.md` or `.mdx` to a documentation URL to get the processed Markdown content for that page.
12
+ Geistdocs lets AI tools and language models access documentation pages as plain Markdown. Append `.md` or `.mdx` to a documentation URL to get the page content with presentation-only MDX components removed.
13
13
 
14
14
  <CopyPrompt text="Help me test raw Markdown routes in this Geistdocs project. Fetch a docs page with .mdx appended, compare it to the rendered page, and explain how AI tools can use it.">
15
15
  Help me test raw Markdown routes in this Geistdocs project. Fetch a docs page with `.mdx` appended, compare it to the rendered page, and explain how AI tools can use it.
@@ -31,8 +31,8 @@ https://yourdomain.com/docs/getting-started.mdx
31
31
 
32
32
  The `.mdx` version returns:
33
33
 
34
- - The page title as an H1 heading
35
- - The full processed Markdown content
34
+ - Frontmatter with the canonical page URL, docs index, and last-updated date when available
35
+ - The full page content as plain Markdown
36
36
  - No HTML, styling, or navigation
37
37
 
38
38
  For a docs section mounted at `/docs`, the section root remains `/docs.md`. For a source mounted at the app root with `baseUrl: "/"`, Geistdocs uses `/index.md` for the root page. If Next.js has `basePath: "/docs"`, that public root Markdown URL is `/docs/index.md`.
@@ -81,11 +81,30 @@ The response includes:
81
81
 
82
82
  - Content-Type: `text/markdown`
83
83
  - `Link: <canonical page URL>; rel="canonical"` for resolved pages
84
- - The page title as a level 1 heading
85
- - Processed Markdown content from Fumadocs
84
+ - Frontmatter with page metadata and discovery links
85
+ - Page content with presentation-only MDX components removed
86
86
 
87
87
  All MDX components are processed and converted to plain Markdown equivalents.
88
88
 
89
+ ### Customize frontmatter
90
+
91
+ Geistdocs generates `title`, `description`, `url`, `docs_index`, and `lastUpdated` when their values are available, along with supported page frontmatter such as `prerequisites` and `related`. Add product-specific fields or override defaults with the source `markdown.frontmatter` hook:
92
+
93
+ ```ts title="lib/geistdocs/source.ts"
94
+ export const geistdocsSource = createSource({
95
+ config,
96
+ docs,
97
+ markdown: {
98
+ frontmatter: (defaults) => ({
99
+ docs_index: "/docs/llms.txt",
100
+ version: "16.3.4",
101
+ }),
102
+ },
103
+ });
104
+ ```
105
+
106
+ The callback returns only additions and overrides; Geistdocs keeps the remaining generated fields from `defaults`.
107
+
89
108
  ## Missing documentation pages
90
109
 
91
110
  When a Markdown request does not match a page, Geistdocs returns an agent-readable `Page Not Found` response. It compares the requested path with visible page paths and titles, then links up to five likely matches with their descriptions. If no match is useful, the response links to `/llms.txt` instead.
@@ -9,12 +9,15 @@
9
9
  "env",
10
10
  "deployment",
11
11
  "migration",
12
+ "packages",
12
13
  "configuration",
13
14
  "---Internals---",
14
15
  "syntax",
15
16
  "provider",
16
17
  "versioned-docs",
17
18
  "proxy",
19
+ "---Components---",
20
+ "components",
18
21
  "---Features---",
19
22
  "changelog",
20
23
  "...",
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: Migration guide
2
+ title: Migrate to Geistdocs
3
3
  description: Migrate a Fumadocs or custom Geist docs site to package-backed Geistdocs
4
4
  type: guide
5
5
  summary: Move an existing documentation site to @vercel/geistdocs while keeping local content, routing, middleware behavior, and AI-readable surfaces intact.
@@ -14,12 +14,12 @@ related:
14
14
 
15
15
  Migrate an existing Fumadocs or custom Geist documentation site to `@vercel/geistdocs` by moving shared behavior into package APIs and keeping site-specific adapters local. The safest migration keeps content, routing decisions, and product-specific UI in your app while replacing copied runtime code with thin package-backed adapters.
16
16
 
17
- <Callout title="Geistcn is available on canary">
18
- The current Geistcn migration is available from the `canary` dist-tag, not `latest`. The canary depends on restricted `@vercel/geistcn` packages and is intended for Vercel-internal projects while the migration is evaluated.
17
+ <Callout title="Choose the package first">
18
+ Use `@vercel/geistdocs` by default, including in Vercel-owned OSS repositories. Use `@vercel/geistdocs-private` only in an internal environment that already has private npm access. See [Choose a Geistdocs package](/docs/packages).
19
19
  </Callout>
20
20
 
21
- <CopyPrompt text="Help me migrate this existing docs site to package-backed Geistdocs. First determine whether I should use the stable release or the Geistcn canary. 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. For the Geistcn canary, also inspect package authentication, @vercel/geistdocs component and asset imports, root HTML classes, and Next.js configuration. Pin the selected version and use package APIs without copying package internals.">
22
- Help me migrate this existing docs site to package-backed Geistdocs. First determine whether I should use the stable release or the Geistcn canary. 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. For the Geistcn canary, also inspect package authentication, `@vercel/geistdocs` component and asset imports, root HTML classes, and Next.js configuration. Pin the selected version and use package APIs without copying package internals.
21
+ <CopyPrompt text="Help me migrate this existing docs site to package-backed Geistdocs. Inspect source.config.ts, lib/geistdocs/source.ts, app route files, proxy.ts or middleware.ts, public/llms.txt, Open Graph routes, Tailwind CSS setup, package.json AI SDK dependencies, and environment variables. Then produce a step-by-step migration plan using @vercel/geistdocs package APIs without copying package internals.">
22
+ Help me migrate this existing docs site to package-backed Geistdocs. Inspect `source.config.ts`, `lib/geistdocs/source.ts`, app route files, `proxy.ts` or `middleware.ts`, `public/llms.txt`, Open Graph routes, Tailwind CSS setup, `package.json` AI SDK dependencies, and environment variables. Then produce a step-by-step migration plan using `@vercel/geistdocs` package APIs without copying package internals.
23
23
  </CopyPrompt>
24
24
 
25
25
  ## Before you migrate
@@ -47,7 +47,9 @@ Fix unrelated build failures first. A migration is safer when the starting point
47
47
 
48
48
  ## Install Geistdocs
49
49
 
50
- For the current stable package-backed release, install `latest` and record the exact resolved version:
50
+ Add `@vercel/geistdocs` and align the supported Fumadocs and Next.js dependencies for the package version you are adopting. Geistdocs requires Next.js 16.3.3 or later within 16.x. Earlier 16.3 releases can retain an optional catch-all route's index content after a client navigation to a child page when Cache Components and Partial Prefetching are enabled.
51
+
52
+ For an existing project, use your package manager directly:
51
53
 
52
54
  ```bash title="Terminal"
53
55
  pnpm add --save-exact @vercel/geistdocs@latest
@@ -108,7 +110,8 @@ Replace imports according to this table:
108
110
 
109
111
  | Previous Geistdocs import | Replacement |
110
112
  | --- | --- |
111
- | `components/badge`, `components/button`, `components/dialog`, `components/drawer`, `components/input`, `components/kbd`, `components/separator`, `components/sheet`, `components/spinner`, `components/textarea`, `components/theme-switcher`, or `components/tooltip` | Import the matching component directly from `@vercel/geistcn/components/<name>`. |
113
+ | `components/badge`, `components/button`, or `components/theme-switcher` | Keep the import package-backed. Geistdocs resolves these template primitives through the selected public or private provider. |
114
+ | `components/dialog`, `components/drawer`, `components/input`, `components/kbd`, `components/separator`, `components/sheet`, `components/spinner`, `components/textarea`, or `components/tooltip` | Import the matching component directly from `@vercel/geistcn/components/<name>` in approved private projects, or keep an application-owned public equivalent. |
112
115
  | `components/switch` | Import toggle controls from `@vercel/geistcn/components/toggle`. |
113
116
  | `components/sonner` | Use `Toasts` and `useToasts` from `@vercel/geistcn/components/toasts`. |
114
117
  | `components/theme-aware-image` | Use `Image` from `@vercel/geistcn/components/image` with `srcLight` and `srcDark`. |
@@ -496,16 +499,10 @@ For a base-path application whose root page is documentation, add `"/"` to the s
496
499
  Stable Geistdocs uses Tailwind CSS v4 with source entries for package components and related dependencies:
497
500
 
498
501
  ```css title="app/styles/geistdocs.css"
499
- @import "tailwindcss";
500
- @import "fumadocs-ui/css/shadcn.css";
501
- @import "fumadocs-ui/css/preset.css";
502
- @import "tw-animate-css";
503
-
504
- @source "../../node_modules/@vercel/geistdocs/dist/**/*.js";
505
- @source "../../node_modules/streamdown/dist/*.js";
502
+ @import "@vercel/geistdocs/styles.css";
506
503
  ```
507
504
 
508
- Move Tailwind CSS v3 plugin utilities into CSS-first v4 utilities or theme variables. Keep custom token names stable while you migrate components.
505
+ The package stylesheet owns the provider foundation, Geist tokens, typography, Fumadocs integration, and compiled runtime source discovery.
509
506
 
510
507
  ### Configure Tailwind CSS for the Geistcn canary
511
508
 
@@ -513,7 +510,6 @@ For the Geistcn canary, use the import order and narrow Geistcn source scan from
513
510
 
514
511
  ```css title="app/styles/geistdocs.css"
515
512
  @import "@vercel/geistcn/tailwind.css";
516
- @import "fumadocs-ui/css/shadcn.css";
517
513
  @import "fumadocs-ui/css/preset.css";
518
514
  @import "@vercel/geistdocs/theme.css";
519
515
  @import "@vercel/geistcn/styles.css";
@@ -0,0 +1,53 @@
1
+ ---
2
+ title: Choose a Geistdocs package
3
+ navTitle: Public and private packages
4
+ badge: New
5
+ description: Choose between the public Geistdocs package and Vercel's private Geistcn-backed package
6
+ type: guide
7
+ summary: Use the public package by default and the private package only where restricted Vercel npm dependencies are already available.
8
+ related:
9
+ - /docs/getting-started
10
+ - /docs/deployment
11
+ - /docs/migration
12
+ ---
13
+
14
+ Geistdocs ships as two packages built from the same runtime and template. They expose the same API and intentionally share the same visual design, layout, interactions, and product behavior. A site should look and work the same with either package; only the underlying primitive and asset provider differs.
15
+
16
+ <Callout title="Geistdocs Private uses restricted packages">
17
+ `@vercel/geistdocs-private` is private because it directly uses the restricted `@vercel/geistcn` component library and `@vercel/geistcn-assets`—not simply because a repository is owned by Vercel. Vercel-owned OSS repositories are public and must use `@vercel/geistdocs`. The restricted packages contain Vercel product UI primitives and assets that are not distributed for public use. Giving external contributors access would expose the building blocks needed to closely reproduce Vercel product interfaces. Do not publish, redistribute, or expose the package, its dependencies, registry credentials, or downloaded artifacts outside internal environments authorized to use them.
18
+ </Callout>
19
+
20
+ | Package | Access | UI provider | Recommended use |
21
+ | --- | --- | --- | --- |
22
+ | `@vercel/geistdocs` | Public | Package-owned public primitives and vendored assets | Open-source repositories, external contributors, and all projects without private Vercel npm access |
23
+ | `@vercel/geistdocs-private` | Private; restricted access | Restricted `@vercel/geistcn` components and `@vercel/geistcn-assets`; requires authenticated access to Vercel's private npm registry | Internal environments such as `front`; never public repositories or projects requiring external contributor access |
24
+
25
+ ## Use the public package by default
26
+
27
+ Create a public Geistdocs project with:
28
+
29
+ ```bash title="Terminal"
30
+ pnpm dlx @vercel/geistdocs@latest init --name my-docs
31
+ ```
32
+
33
+ The generated project has no dependency or peer dependency on `@vercel/geistcn` or `@vercel/geistcn-assets`. Contributors can install it using normal public npm access.
34
+
35
+ ## Use the private package inside Vercel
36
+
37
+ Create the private variant with:
38
+
39
+ ```bash title="Terminal"
40
+ pnpm dlx @vercel/geistdocs-private@latest init --name my-docs
41
+ ```
42
+
43
+ The private initializer asks whether the generated template will be used in a public repository. Answer **Yes** to generate the public `@vercel/geistdocs` variant without restricted dependencies. Answer **No** to keep `@vercel/geistdocs-private`.
44
+
45
+ The private package declares `@vercel/geistcn` and `@vercel/geistcn-assets` as peer dependencies. Both local development and deployment must be authenticated to Vercel's private npm registry. This makes it suitable only for internal environments such as `front`, where that access already exists and remains limited to authorized Vercel users.
46
+
47
+ Do not use the private package in a public repository or provide its registry access to external contributors. Use the public package whenever anyone outside Vercel needs to install, build, or contribute to the project—even if the site itself is deployed on Vercel.
48
+
49
+ ## Keep package identities consistent
50
+
51
+ The CLI writes the package that initialized the project into every generated import and dependency. Keep one Geistdocs package throughout the app and update it with that package's CLI. Do not install both variants or combine imports from them.
52
+
53
+ Switching variants should require only changing package identity and provider-specific dependency metadata. Application content, configuration, route adapters, and Geistdocs APIs remain the same.