@vercel/geistdocs 1.2.2 → 1.2.3-canary.1d733b2

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 (384) 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/dist/assets/icons/index.js +10 -0
  31. package/dist/assets/logos/index.d.ts +15 -0
  32. package/dist/assets/logos/index.d.ts.map +1 -0
  33. package/dist/assets/logos/index.js +15 -0
  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 +3 -0
  65. package/dist/components/callout.d.ts +12 -0
  66. package/dist/components/callout.d.ts.map +1 -0
  67. package/dist/components/callout.js +7 -0
  68. package/dist/components/code-block-tabs.d.ts +7 -0
  69. package/dist/components/code-block-tabs.d.ts.map +1 -0
  70. package/dist/components/code-block-tabs.js +7 -0
  71. package/dist/components/code-block.d.ts +14 -0
  72. package/dist/components/code-block.d.ts.map +1 -0
  73. package/dist/components/code-block.js +45 -0
  74. package/dist/components/copy-prompt.d.ts +11 -0
  75. package/dist/components/copy-prompt.d.ts.map +1 -0
  76. package/dist/components/copy-prompt.js +58 -0
  77. package/dist/components/mermaid.d.ts +4 -0
  78. package/dist/components/mermaid.d.ts.map +1 -0
  79. package/dist/components/mermaid.js +44 -0
  80. package/dist/components/theme-aware-image.d.ts +12 -0
  81. package/dist/components/theme-aware-image.d.ts.map +1 -0
  82. package/dist/components/theme-aware-image.js +8 -0
  83. package/dist/components/video.d.ts +6 -0
  84. package/dist/components/video.d.ts.map +1 -0
  85. package/dist/components/video.js +3 -0
  86. package/dist/config.d.ts +117 -0
  87. package/dist/config.d.ts.map +1 -0
  88. package/dist/config.js +1 -0
  89. package/dist/controls.d.ts +15 -0
  90. package/dist/controls.d.ts.map +1 -0
  91. package/dist/controls.js +52 -0
  92. package/dist/footer.d.ts +8 -0
  93. package/dist/footer.d.ts.map +1 -0
  94. package/dist/footer.js +6 -0
  95. package/dist/home-layout.d.ts +11 -0
  96. package/dist/home-layout.d.ts.map +1 -0
  97. package/dist/home-layout.js +31 -0
  98. package/dist/internal/chat/context.d.ts +19 -0
  99. package/dist/internal/chat/context.d.ts.map +1 -0
  100. package/dist/internal/chat/context.js +36 -0
  101. package/dist/internal/chat/conversation.d.ts +10 -0
  102. package/dist/internal/chat/conversation.d.ts.map +1 -0
  103. package/dist/internal/chat/conversation.js +16 -0
  104. package/dist/internal/chat/copy-chat.d.ts +5 -0
  105. package/dist/internal/chat/copy-chat.d.ts.map +1 -0
  106. package/dist/internal/chat/copy-chat.js +35 -0
  107. package/dist/internal/chat/db.d.ts +13 -0
  108. package/dist/internal/chat/db.d.ts.map +1 -0
  109. package/dist/internal/chat/db.js +19 -0
  110. package/dist/internal/chat/message-metadata.d.ts +8 -0
  111. package/dist/internal/chat/message-metadata.d.ts.map +1 -0
  112. package/dist/internal/chat/message-metadata.js +29 -0
  113. package/dist/internal/chat/message.d.ts +11 -0
  114. package/dist/internal/chat/message.d.ts.map +1 -0
  115. package/dist/internal/chat/message.js +11 -0
  116. package/dist/internal/chat/prompt-input.d.ts +13 -0
  117. package/dist/internal/chat/prompt-input.d.ts.map +1 -0
  118. package/dist/internal/chat/prompt-input.js +39 -0
  119. package/dist/internal/chat/shell.d.ts +2 -0
  120. package/dist/internal/chat/shell.d.ts.map +1 -0
  121. package/dist/internal/chat/shell.js +194 -0
  122. package/dist/internal/chat/shimmer.d.ts +11 -0
  123. package/dist/internal/chat/shimmer.d.ts.map +1 -0
  124. package/dist/internal/chat/shimmer.js +18 -0
  125. package/dist/internal/chat/sources.d.ts +13 -0
  126. package/dist/internal/chat/sources.d.ts.map +1 -0
  127. package/dist/internal/chat/sources.js +9 -0
  128. package/dist/internal/chat/suggestion.d.ts +11 -0
  129. package/dist/internal/chat/suggestion.d.ts.map +1 -0
  130. package/dist/internal/chat/suggestion.js +12 -0
  131. package/dist/internal/cn.d.ts +3 -0
  132. package/dist/internal/cn.d.ts.map +1 -0
  133. package/dist/internal/cn.js +3 -0
  134. package/dist/internal/config-context.d.ts +10 -0
  135. package/dist/internal/config-context.d.ts.map +1 -0
  136. package/dist/internal/config-context.js +15 -0
  137. package/dist/internal/feedback-action.d.ts +14 -0
  138. package/dist/internal/feedback-action.d.ts.map +1 -0
  139. package/dist/internal/feedback-action.js +34 -0
  140. package/dist/internal/footer/github-button.d.ts +7 -0
  141. package/dist/internal/footer/github-button.d.ts.map +1 -0
  142. package/dist/internal/footer/github-button.js +10 -0
  143. package/dist/internal/footer/rss-button.d.ts +2 -0
  144. package/dist/internal/footer/rss-button.d.ts.map +1 -0
  145. package/dist/internal/footer/rss-button.js +4 -0
  146. package/dist/internal/i18n.d.ts +6 -0
  147. package/dist/internal/i18n.d.ts.map +1 -0
  148. package/dist/internal/i18n.js +18 -0
  149. package/dist/internal/languages.d.ts +7 -0
  150. package/dist/internal/languages.d.ts.map +1 -0
  151. package/dist/internal/languages.js +18 -0
  152. package/dist/internal/localized-link.d.ts +8 -0
  153. package/dist/internal/localized-link.d.ts.map +1 -0
  154. package/dist/internal/localized-link.js +13 -0
  155. package/dist/internal/navbar/desktop-menu.d.ts +10 -0
  156. package/dist/internal/navbar/desktop-menu.d.ts.map +1 -0
  157. package/dist/internal/navbar/desktop-menu.js +11 -0
  158. package/dist/internal/navbar/mobile-menu.d.ts +7 -0
  159. package/dist/internal/navbar/mobile-menu.d.ts.map +1 -0
  160. package/dist/internal/navbar/mobile-menu.js +44 -0
  161. package/dist/internal/navbar/navbar-logo.d.ts +16 -0
  162. package/dist/internal/navbar/navbar-logo.d.ts.map +1 -0
  163. package/dist/internal/navbar/navbar-logo.js +30 -0
  164. package/dist/internal/not-implemented.d.ts +2 -0
  165. package/dist/internal/not-implemented.d.ts.map +1 -0
  166. package/dist/internal/not-implemented.js +4 -0
  167. package/dist/internal/page-actions-client.d.ts +13 -0
  168. package/dist/internal/page-actions-client.d.ts.map +1 -0
  169. package/dist/internal/page-actions-client.js +171 -0
  170. package/dist/internal/page-actions.d.ts +18 -0
  171. package/dist/internal/page-actions.d.ts.map +1 -0
  172. package/dist/internal/page-actions.js +4 -0
  173. package/dist/internal/page-visibility.d.ts +18 -0
  174. package/dist/internal/page-visibility.d.ts.map +1 -0
  175. package/dist/internal/page-visibility.js +24 -0
  176. package/dist/internal/provider-client.d.ts +9 -0
  177. package/dist/internal/provider-client.d.ts.map +1 -0
  178. package/dist/internal/provider-client.js +24 -0
  179. package/dist/internal/search.d.ts +5 -0
  180. package/dist/internal/search.d.ts.map +1 -0
  181. package/dist/internal/search.js +14 -0
  182. package/dist/internal/sidebar.d.ts +9 -0
  183. package/dist/internal/sidebar.d.ts.map +1 -0
  184. package/dist/internal/sidebar.js +38 -0
  185. package/dist/internal/table-of-contents.d.ts +9 -0
  186. package/dist/internal/table-of-contents.d.ts.map +1 -0
  187. package/dist/internal/table-of-contents.js +5 -0
  188. package/dist/internal/ui/button-group.d.ts +13 -0
  189. package/dist/internal/ui/button-group.d.ts.map +1 -0
  190. package/dist/internal/ui/button-group.js +26 -0
  191. package/dist/internal/ui/button.d.ts +12 -0
  192. package/dist/internal/ui/button.d.ts.map +1 -0
  193. package/dist/internal/ui/button.js +33 -0
  194. package/dist/internal/ui/card.d.ts +6 -0
  195. package/dist/internal/ui/card.d.ts.map +1 -0
  196. package/dist/internal/ui/card.js +14 -0
  197. package/dist/internal/ui/collapsible.d.ts +6 -0
  198. package/dist/internal/ui/collapsible.d.ts.map +1 -0
  199. package/dist/internal/ui/collapsible.js +12 -0
  200. package/dist/internal/ui/drawer.d.ts +6 -0
  201. package/dist/internal/ui/drawer.d.ts.map +1 -0
  202. package/dist/internal/ui/drawer.js +13 -0
  203. package/dist/internal/ui/dropdown-menu.d.ts +22 -0
  204. package/dist/internal/ui/dropdown-menu.d.ts.map +1 -0
  205. package/dist/internal/ui/dropdown-menu.js +41 -0
  206. package/dist/internal/ui/input-group.d.ts +15 -0
  207. package/dist/internal/ui/input-group.d.ts.map +1 -0
  208. package/dist/internal/ui/input-group.js +44 -0
  209. package/dist/internal/ui/input.d.ts +3 -0
  210. package/dist/internal/ui/input.d.ts.map +1 -0
  211. package/dist/internal/ui/input.js +5 -0
  212. package/dist/internal/ui/kbd.d.ts +4 -0
  213. package/dist/internal/ui/kbd.d.ts.map +1 -0
  214. package/dist/internal/ui/kbd.js +8 -0
  215. package/dist/internal/ui/navigation-menu.d.ts +17 -0
  216. package/dist/internal/ui/navigation-menu.d.ts.map +1 -0
  217. package/dist/internal/ui/navigation-menu.js +38 -0
  218. package/dist/internal/ui/popover.d.ts +6 -0
  219. package/dist/internal/ui/popover.d.ts.map +1 -0
  220. package/dist/internal/ui/popover.js +13 -0
  221. package/dist/internal/ui/scroll-area.d.ts +5 -0
  222. package/dist/internal/ui/scroll-area.d.ts.map +1 -0
  223. package/dist/internal/ui/scroll-area.js +12 -0
  224. package/dist/internal/ui/separator.d.ts +4 -0
  225. package/dist/internal/ui/separator.d.ts.map +1 -0
  226. package/dist/internal/ui/separator.js +7 -0
  227. package/dist/internal/ui/sheet.d.ts +10 -0
  228. package/dist/internal/ui/sheet.d.ts.map +1 -0
  229. package/dist/internal/ui/sheet.js +24 -0
  230. package/dist/internal/ui/sonner.d.ts +3 -0
  231. package/dist/internal/ui/sonner.d.ts.map +1 -0
  232. package/dist/internal/ui/sonner.js +20 -0
  233. package/dist/internal/ui/spinner.d.ts +3 -0
  234. package/dist/internal/ui/spinner.d.ts.map +1 -0
  235. package/dist/internal/ui/spinner.js +6 -0
  236. package/dist/internal/ui/textarea.d.ts +3 -0
  237. package/dist/internal/ui/textarea.d.ts.map +1 -0
  238. package/dist/internal/ui/textarea.js +5 -0
  239. package/dist/internal/ui/tooltip.d.ts +7 -0
  240. package/dist/internal/ui/tooltip.d.ts.map +1 -0
  241. package/dist/internal/ui/tooltip.js +16 -0
  242. package/dist/internal/use-mobile.d.ts +2 -0
  243. package/dist/internal/use-mobile.d.ts.map +1 -0
  244. package/dist/internal/use-mobile.js +16 -0
  245. package/dist/layout.d.ts +14 -0
  246. package/dist/layout.d.ts.map +1 -0
  247. package/dist/layout.js +31 -0
  248. package/dist/mdx.d.ts +67 -0
  249. package/dist/mdx.d.ts.map +1 -0
  250. package/dist/mdx.js +35 -0
  251. package/dist/mobile-docs-bar.d.ts +7 -0
  252. package/dist/mobile-docs-bar.d.ts.map +1 -0
  253. package/dist/mobile-docs-bar.js +13 -0
  254. package/dist/navbar.d.ts +7 -0
  255. package/dist/navbar.d.ts.map +1 -0
  256. package/dist/navbar.js +10 -0
  257. package/dist/pages/docs.d.ts +83 -0
  258. package/dist/pages/docs.d.ts.map +1 -0
  259. package/dist/pages/docs.js +98 -0
  260. package/dist/proxy.d.ts +37 -0
  261. package/dist/proxy.d.ts.map +1 -0
  262. package/dist/proxy.js +189 -0
  263. package/dist/routes/agents.d.ts +21 -0
  264. package/dist/routes/agents.d.ts.map +1 -0
  265. package/dist/routes/agents.js +201 -0
  266. package/dist/routes/chat.d.ts +14 -0
  267. package/dist/routes/chat.d.ts.map +1 -0
  268. package/dist/routes/chat.js +251 -0
  269. package/dist/routes/llms.d.ts +52 -0
  270. package/dist/routes/llms.d.ts.map +1 -0
  271. package/dist/routes/llms.js +110 -0
  272. package/dist/routes/search.d.ts +13 -0
  273. package/dist/routes/search.d.ts.map +1 -0
  274. package/dist/routes/search.js +81 -0
  275. package/dist/routes/sitemap.d.ts +47 -0
  276. package/dist/routes/sitemap.d.ts.map +1 -0
  277. package/dist/routes/sitemap.js +176 -0
  278. package/dist/shiki-theme.d.ts +20 -0
  279. package/dist/shiki-theme.d.ts.map +1 -0
  280. package/dist/shiki-theme.js +110 -0
  281. package/dist/sidebar.d.ts +11 -0
  282. package/dist/sidebar.d.ts.map +1 -0
  283. package/dist/sidebar.js +16 -0
  284. package/dist/source-config.d.ts +68 -0
  285. package/dist/source-config.d.ts.map +1 -0
  286. package/dist/source-config.js +161 -0
  287. package/dist/source.d.ts +181 -0
  288. package/dist/source.d.ts.map +1 -0
  289. package/dist/source.js +142 -0
  290. package/dist/versions.d.ts +45 -0
  291. package/dist/versions.d.ts.map +1 -0
  292. package/dist/versions.js +79 -0
  293. package/package.json +186 -9
  294. package/source-config.js +174 -0
  295. package/styles.css +556 -0
  296. package/template/AGENTS.md +82 -0
  297. package/template/_gitignore +29 -0
  298. package/template/app/[lang]/(home)/components/centered-section.tsx +24 -0
  299. package/template/app/[lang]/(home)/components/cta.tsx +19 -0
  300. package/template/app/[lang]/(home)/components/hero.tsx +27 -0
  301. package/template/app/[lang]/(home)/components/one-two-section.tsx +23 -0
  302. package/template/app/[lang]/(home)/components/templates.tsx +48 -0
  303. package/template/app/[lang]/(home)/components/text-grid-section.tsx +20 -0
  304. package/template/app/[lang]/(home)/layout.tsx +15 -0
  305. package/template/app/[lang]/(home)/page.tsx +126 -0
  306. package/template/app/[lang]/agents.md/route.ts +6 -0
  307. package/template/app/[lang]/docs/[[...slug]]/page.tsx +22 -0
  308. package/template/app/[lang]/docs/layout.tsx +14 -0
  309. package/template/app/[lang]/layout.tsx +29 -0
  310. package/template/app/[lang]/llms.mdx/[[...slug]]/route.ts +7 -0
  311. package/template/app/[lang]/llms.txt/route.ts +6 -0
  312. package/template/app/[lang]/og/[...slug]/background.png +0 -0
  313. package/template/app/[lang]/og/[...slug]/geist-sans-regular.ttf +0 -0
  314. package/template/app/[lang]/og/[...slug]/geist-sans-semibold.ttf +0 -0
  315. package/template/app/[lang]/og/[...slug]/route.tsx +95 -0
  316. package/template/app/[lang]/rss.xml/route.ts +52 -0
  317. package/template/app/[lang]/sitemap.md/route.ts +9 -0
  318. package/template/app/api/chat/route.ts +8 -0
  319. package/template/app/api/search/route.ts +5 -0
  320. package/template/app/favicon.ico +0 -0
  321. package/template/app/global.css +2 -0
  322. package/template/app/robots.ts +14 -0
  323. package/template/app/sitemap.ts +36 -0
  324. package/template/app/styles/geistdocs.css +595 -0
  325. package/template/components/geistdocs/docs-layout.tsx +20 -0
  326. package/template/components/geistdocs/mdx-components.tsx +5 -0
  327. package/template/components/geistdocs/provider.tsx +31 -0
  328. package/template/components/ui/badge.tsx +46 -0
  329. package/template/components/ui/button.tsx +60 -0
  330. package/template/components/ui/command-prompt.tsx +488 -0
  331. package/template/components.json +22 -0
  332. package/template/content/docs/agent-readiness.mdx +103 -0
  333. package/template/content/docs/ask-ai.cn.mdx +85 -0
  334. package/template/content/docs/ask-ai.mdx +89 -0
  335. package/template/content/docs/configuration.cn.mdx +155 -0
  336. package/template/content/docs/configuration.mdx +275 -0
  337. package/template/content/docs/deployment.cn.mdx +34 -0
  338. package/template/content/docs/deployment.mdx +40 -0
  339. package/template/content/docs/edit-on-github.cn.mdx +47 -0
  340. package/template/content/docs/edit-on-github.mdx +51 -0
  341. package/template/content/docs/env.cn.mdx +25 -0
  342. package/template/content/docs/env.mdx +29 -0
  343. package/template/content/docs/feedback.cn.mdx +85 -0
  344. package/template/content/docs/feedback.mdx +89 -0
  345. package/template/content/docs/getting-started.cn.mdx +86 -0
  346. package/template/content/docs/getting-started.mdx +108 -0
  347. package/template/content/docs/index.cn.mdx +57 -0
  348. package/template/content/docs/index.mdx +95 -0
  349. package/template/content/docs/internationalization.cn.mdx +111 -0
  350. package/template/content/docs/internationalization.mdx +122 -0
  351. package/template/content/docs/llms-txt.cn.mdx +72 -0
  352. package/template/content/docs/llms-txt.mdx +86 -0
  353. package/template/content/docs/md.cn.mdx +65 -0
  354. package/template/content/docs/md.mdx +82 -0
  355. package/template/content/docs/meta.json +25 -0
  356. package/template/content/docs/migration.mdx +321 -0
  357. package/template/content/docs/open-in-chat.cn.mdx +78 -0
  358. package/template/content/docs/open-in-chat.mdx +80 -0
  359. package/template/content/docs/provider.cn.mdx +70 -0
  360. package/template/content/docs/provider.mdx +74 -0
  361. package/template/content/docs/proxy.cn.mdx +96 -0
  362. package/template/content/docs/proxy.mdx +178 -0
  363. package/template/content/docs/rss.cn.mdx +104 -0
  364. package/template/content/docs/rss.mdx +108 -0
  365. package/template/content/docs/syntax.cn.mdx +416 -0
  366. package/template/content/docs/syntax.mdx +411 -0
  367. package/template/content/docs/theme-aware-image.mdx +57 -0
  368. package/template/content/docs/versioned-docs.cn.mdx +117 -0
  369. package/template/content/docs/versioned-docs.mdx +228 -0
  370. package/template/geistdocs.tsx +77 -0
  371. package/template/lib/geistdocs/config.tsx +30 -0
  372. package/template/lib/geistdocs/fonts.ts +18 -0
  373. package/template/lib/geistdocs/i18n.ts +13 -0
  374. package/template/lib/geistdocs/md-tracking.ts +56 -0
  375. package/template/lib/geistdocs/source.ts +12 -0
  376. package/template/lib/utils.ts +6 -0
  377. package/template/next.config.ts +22 -0
  378. package/template/package.json +63 -0
  379. package/template/postcss.config.mjs +5 -0
  380. package/template/proxy.ts +17 -0
  381. package/template/source.config.ts +23 -0
  382. package/template/tsconfig.json +37 -0
  383. package/dist/index.js +0 -2
  384. /package/dist/{index.d.ts → cli/index.d.ts} +0 -0
@@ -0,0 +1,416 @@
1
+ ---
2
+ title: 语法
3
+ description: 了解受支持的 Markdown 语法和格式选项
4
+ type: reference
5
+ summary: 支持的 MDX 语法,包括文本格式、代码块、行高亮和 Mermaid 图表。
6
+ prerequisites:
7
+ - /docs/getting-started
8
+ related:
9
+ - /docs/configuration
10
+ ---
11
+
12
+ Geistdocs 支持 MDX,这是 Markdown 的超集,允许您在文档中使用 JSX 组件。本指南涵盖所有可用的格式选项。
13
+
14
+ ## Frontmatter
15
+
16
+ 每个 MDX 文件应在顶部包含 frontmatter:
17
+
18
+ ```yaml
19
+ ---
20
+ title: Page Title
21
+ description: A brief description of the page content
22
+ ---
23
+ ```
24
+
25
+ `title` 属性为必填,用于页面标题和导航。`description` 用于 SEO 和页面预览。
26
+
27
+ ## Basic Markdown
28
+
29
+ ### 文本格式
30
+
31
+ 您可以使用标准 Markdown 语法来设置文本样式:
32
+
33
+ - **加粗文本** 使用 `**double asterisks**`
34
+ - _斜体文本_ 使用 `*single asterisks*`
35
+ - ~~删除线~~ 使用 `~~double tildes~~`
36
+ - `行内代码` 使用 `` `backticks` ``
37
+
38
+ ### 标题
39
+
40
+ 使用 `#` 符号创建标题:
41
+
42
+ ```text
43
+ # Heading 1
44
+
45
+ ## Heading 2
46
+
47
+ ### Heading 3
48
+
49
+ #### Heading 4
50
+
51
+ ##### Heading 5
52
+
53
+ ###### Heading 6
54
+ ```
55
+
56
+ 标题会自动生成锚点链接,便于导航和深度链接。
57
+
58
+ ### 列表
59
+
60
+ 使用 `-`、`*` 或 `+` 创建无序列表:
61
+
62
+ - 第一项
63
+ - 第二项
64
+ - 嵌套项
65
+ - 另一个嵌套项
66
+ - 第三项
67
+
68
+ 使用数字创建有序列表:
69
+
70
+ 1. 第一步
71
+ 2. 第二步
72
+ 3. 第三步
73
+
74
+ ### 引用
75
+
76
+ 使用 `>` 创建引用:
77
+
78
+ > 这是一个引用。您可以用它来突出重要信息或引用外部来源。
79
+
80
+ ### 链接
81
+
82
+ 使用 `[text](url)` 创建链接:
83
+
84
+ - [外部链接](https://vercel.com)
85
+ - [内部链接](/docs/getting-started)
86
+
87
+ ### 图片
88
+
89
+ 使用 `![alt text](url)` 添加图片:
90
+
91
+ ```md
92
+ ![Description of the image](/path/to/image.png)
93
+ ```
94
+
95
+ ## GitHub Flavored Markdown
96
+
97
+ Geistdocs 支持 GFM 扩展,包括表格、任务列表和自动链接。
98
+
99
+ ### 表格
100
+
101
+ 使用竖线和短横线创建表格:
102
+
103
+ ```md
104
+ | Feature | Description | Status |
105
+ | -------- | ----------------- | --------- |
106
+ | Markdown | Basic formatting | Supported |
107
+ | GFM | GitHub extensions | Supported |
108
+ | MDX | JSX in Markdown | Supported |
109
+ ```
110
+
111
+ 渲染为:
112
+
113
+ | Feature | Description | Status |
114
+ | -------- | ----------------- | --------- |
115
+ | Markdown | Basic formatting | Supported |
116
+ | GFM | GitHub extensions | Supported |
117
+ | MDX | JSX in Markdown | Supported |
118
+
119
+ ### 任务列表
120
+
121
+ 创建交互式任务列表:
122
+
123
+ ```md
124
+ - [x] Completed task
125
+ - [ ] Incomplete task
126
+ - [ ] Another task to do
127
+ ```
128
+
129
+ 渲染为:
130
+
131
+ - [x] 已完成任务
132
+ - [ ] 未完成任务
133
+ - [ ] 另一个待办任务
134
+
135
+ ### 自动链接
136
+
137
+ URL 会自动转换为可点击链接:
138
+
139
+ ```md
140
+ https://vercel.com
141
+ ```
142
+
143
+ 渲染为:
144
+
145
+ https://vercel.com
146
+
147
+ ## 代码块
148
+
149
+ 围栏代码块支持多种语言的语法高亮。
150
+
151
+ ### 基本语法高亮
152
+
153
+ 在开头的反引号后指定语言:
154
+
155
+ ````md
156
+ ```typescript
157
+ const greet = (name: string): string => {
158
+ return `Hello, ${name}!`;
159
+ };
160
+ ```
161
+ ````
162
+
163
+ 渲染为:
164
+
165
+ ```typescript
166
+ const greet = (name: string): string => {
167
+ return `Hello, ${name}!`;
168
+ };
169
+ ```
170
+
171
+ ### 代码块标题
172
+
173
+ 使用 `title` 属性为代码块添加标题:
174
+
175
+ ````md
176
+ ```tsx title="components/button.tsx"
177
+ export const Button = ({ children }) => {
178
+ return <button type="button">{children}</button>;
179
+ };
180
+ ```
181
+ ````
182
+
183
+ 渲染为:
184
+
185
+ ```tsx title="components/button.tsx"
186
+ export const Button = ({ children }) => {
187
+ return <button type="button">{children}</button>;
188
+ };
189
+ ```
190
+
191
+ ### 行号
192
+
193
+ 通过添加 `lineNumbers` 属性来显示行号:
194
+
195
+ ````md
196
+ ```typescript lineNumbers
197
+ const numbers = [1, 2, 3, 4, 5];
198
+ const doubled = numbers.map((n) => n * 2);
199
+ console.log(doubled);
200
+ ```
201
+ ````
202
+
203
+ 渲染为:
204
+
205
+ ```typescript lineNumbers
206
+ const numbers = [1, 2, 3, 4, 5];
207
+ const doubled = numbers.map((n) => n * 2);
208
+ console.log(doubled);
209
+ ```
210
+
211
+ 您也可以使用 `lineNumbers=10` 指定起始行号:
212
+
213
+ ```typescript lineNumbers=10
214
+ const config = {
215
+ theme: "dark",
216
+ language: "en",
217
+ };
218
+ ```
219
+
220
+ ### 行高亮
221
+
222
+ 使用 `[!code highlight]` 注释高亮特定行:
223
+
224
+ ````md
225
+ ```typescript
226
+ const config = {
227
+ theme: "dark", // [ !code highlight]
228
+ language: "en",
229
+ };
230
+ ```
231
+ ````
232
+
233
+ 在使用此语法时,请移除 `!` 前的空格。渲染为:
234
+
235
+ ```typescript
236
+ const config = {
237
+ theme: "dark", // [!code highlight]
238
+ language: "en",
239
+ };
240
+ ```
241
+
242
+ ### 单词高亮
243
+
244
+ 使用 `[!code word:term]` 高亮特定单词:
245
+
246
+ ````md
247
+ ```typescript
248
+ // [ !code word:config]
249
+ const config = {
250
+ theme: "dark",
251
+ };
252
+
253
+ console.log(config);
254
+ ```
255
+ ````
256
+
257
+ 在使用此语法时,请移除 `!` 前的空格。渲染为:
258
+
259
+ ```typescript
260
+ // [!code word:config]
261
+ const config = {
262
+ theme: "dark",
263
+ };
264
+
265
+ console.log(config);
266
+ ```
267
+
268
+ ### 差异语法
269
+
270
+ 使用 `[!code ++]` 和 `[!code --]` 显示添加和删除:
271
+
272
+ ````md
273
+ ```typescript
274
+ const config = {
275
+ theme: "light", // [ !code --]
276
+ theme: "dark", // [ !code ++]
277
+ language: "en",
278
+ };
279
+ ```
280
+ ````
281
+
282
+ 在使用此语法时,请移除 `!` 前的空格。渲染为:
283
+
284
+ ```typescript
285
+ const config = {
286
+ theme: "light", // [!code --]
287
+ theme: "dark", // [!code ++]
288
+ language: "en",
289
+ };
290
+ ```
291
+
292
+ ### 焦点行
293
+
294
+ 使用 `[!code focus]` 强调特定行:
295
+
296
+ ````md
297
+ ```typescript
298
+ const numbers = [1, 2, 3, 4, 5];
299
+ const sum = numbers.reduce((a, b) => a + b, 0); // [ !code focus]
300
+ console.log(sum);
301
+ ```
302
+ ````
303
+
304
+ 在使用此语法时,请移除 `!` 前的空格。渲染为:
305
+
306
+ ```typescript
307
+ const numbers = [1, 2, 3, 4, 5];
308
+ const sum = numbers.reduce((a, b) => a + b, 0); // [!code focus]
309
+ console.log(sum);
310
+ ```
311
+
312
+ ## Mermaid 图表
313
+
314
+ 使用 Mermaid 语法创建图表和流程图。
315
+
316
+ ### 流程图
317
+
318
+ ````md
319
+ ```mermaid
320
+ graph TD;
321
+ A[Start] --> B{Is it working?};
322
+ B -->|Yes| C[Great!];
323
+ B -->|No| D[Debug];
324
+ D --> B;
325
+ ```
326
+ ````
327
+
328
+ 渲染为:
329
+
330
+ ```mermaid
331
+ graph TD;
332
+ A[Start] --> B{Is it working?};
333
+ B -->|Yes| C[Great!];
334
+ B -->|No| D[Debug];
335
+ D --> B;
336
+ ```
337
+
338
+ ### 时序图
339
+
340
+ ````md
341
+ ```mermaid
342
+ sequenceDiagram
343
+ participant User
344
+ participant API
345
+ participant Database
346
+ User->>API: Request data
347
+ API->>Database: Query
348
+ Database-->>API: Results
349
+ API-->>User: Response
350
+ ```
351
+ ````
352
+
353
+ 渲染为:
354
+
355
+ ```mermaid
356
+ sequenceDiagram
357
+ participant User
358
+ participant API
359
+ participant Database
360
+ User->>API: Request data
361
+ API->>Database: Query
362
+ Database-->>API: Results
363
+ API-->>User: Response
364
+ ```
365
+
366
+ ### 架构图
367
+
368
+ ````md
369
+ ```mermaid
370
+ graph TD;
371
+ subgraph Frontend
372
+ A[Web App]
373
+ B[Mobile App]
374
+ end
375
+ subgraph Backend
376
+ C[API Gateway]
377
+ D[Auth Service]
378
+ E[Data Service]
379
+ end
380
+ subgraph Storage
381
+ F[(Database)]
382
+ G[(Cache)]
383
+ end
384
+ A --> C
385
+ B --> C
386
+ C --> D
387
+ C --> E
388
+ E --> F
389
+ E --> G
390
+ ```
391
+ ````
392
+
393
+ 渲染为:
394
+
395
+ ```mermaid
396
+ graph TD;
397
+ subgraph Frontend
398
+ A[Web App]
399
+ B[Mobile App]
400
+ end
401
+ subgraph Backend
402
+ C[API Gateway]
403
+ D[Auth Service]
404
+ E[Data Service]
405
+ end
406
+ subgraph Storage
407
+ F[(Database)]
408
+ G[(Cache)]
409
+ end
410
+ A --> C
411
+ B --> C
412
+ C --> D
413
+ C --> E
414
+ E --> F
415
+ E --> G
416
+ ```