@vercel/geistdocs 1.2.2 → 1.2.3-canary.a12a9c6
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.
- package/dist/assets/icons/icon-arrow-up-right-small.d.ts +8 -0
- package/dist/assets/icons/icon-arrow-up-right-small.d.ts.map +1 -0
- package/dist/assets/icons/icon-arrow-up-right-small.js +4 -0
- package/dist/assets/icons/icon-arrow-up-right.d.ts +5 -0
- package/dist/assets/icons/icon-arrow-up-right.d.ts.map +1 -0
- package/dist/assets/icons/icon-arrow-up-right.js +4 -0
- package/dist/assets/icons/icon-check.d.ts +5 -0
- package/dist/assets/icons/icon-check.d.ts.map +1 -0
- package/dist/assets/icons/icon-check.js +4 -0
- package/dist/assets/icons/icon-chevron-down-small.d.ts +8 -0
- package/dist/assets/icons/icon-chevron-down-small.d.ts.map +1 -0
- package/dist/assets/icons/icon-chevron-down-small.js +7 -0
- package/dist/assets/icons/icon-chevron-right.d.ts +5 -0
- package/dist/assets/icons/icon-chevron-right.d.ts.map +1 -0
- package/dist/assets/icons/icon-chevron-right.js +4 -0
- package/dist/assets/icons/icon-copy.d.ts +5 -0
- package/dist/assets/icons/icon-copy.d.ts.map +1 -0
- package/dist/assets/icons/icon-copy.js +4 -0
- package/dist/assets/icons/icon-file-text.d.ts +5 -0
- package/dist/assets/icons/icon-file-text.d.ts.map +1 -0
- package/dist/assets/icons/icon-file-text.js +4 -0
- package/dist/assets/icons/icon-menu-alt.d.ts +5 -0
- package/dist/assets/icons/icon-menu-alt.d.ts.map +1 -0
- package/dist/assets/icons/icon-menu-alt.js +4 -0
- package/dist/assets/icons/icon-slash-forward.d.ts +8 -0
- package/dist/assets/icons/icon-slash-forward.d.ts.map +1 -0
- package/dist/assets/icons/icon-slash-forward.js +4 -0
- package/dist/assets/icons/index.d.ts +10 -0
- package/dist/assets/icons/index.d.ts.map +1 -0
- package/dist/assets/icons/index.js +10 -0
- package/dist/assets/logos/index.d.ts +13 -0
- package/dist/assets/logos/index.d.ts.map +1 -0
- package/dist/assets/logos/index.js +13 -0
- package/dist/assets/logos/logo-ai-elements.d.ts +8 -0
- package/dist/assets/logos/logo-ai-elements.d.ts.map +1 -0
- package/dist/assets/logos/logo-ai-elements.js +8 -0
- package/dist/assets/logos/logo-ai-sdk.d.ts +8 -0
- package/dist/assets/logos/logo-ai-sdk.d.ts.map +1 -0
- package/dist/assets/logos/logo-ai-sdk.js +8 -0
- package/dist/assets/logos/logo-chat-sdk.d.ts +8 -0
- package/dist/assets/logos/logo-chat-sdk.d.ts.map +1 -0
- package/dist/assets/logos/logo-chat-sdk.js +8 -0
- package/dist/assets/logos/logo-flags-sdk.d.ts +8 -0
- package/dist/assets/logos/logo-flags-sdk.d.ts.map +1 -0
- package/dist/assets/logos/logo-flags-sdk.js +8 -0
- package/dist/assets/logos/logo-icon-vercel.d.ts +9 -0
- package/dist/assets/logos/logo-icon-vercel.d.ts.map +1 -0
- package/dist/assets/logos/logo-icon-vercel.js +8 -0
- package/dist/assets/logos/logo-streamdown.d.ts +8 -0
- package/dist/assets/logos/logo-streamdown.d.ts.map +1 -0
- package/dist/assets/logos/logo-streamdown.js +8 -0
- package/dist/assets/logos/logo-vercel-oss.d.ts +8 -0
- package/dist/assets/logos/logo-vercel-oss.d.ts.map +1 -0
- package/dist/assets/logos/logo-vercel-oss.js +7 -0
- package/dist/assets/logos/logo-workflow-sdk.d.ts +8 -0
- package/dist/assets/logos/logo-workflow-sdk.d.ts.map +1 -0
- package/dist/assets/logos/logo-workflow-sdk.js +8 -0
- package/dist/cli/index.js +3 -0
- package/dist/components/callout.d.ts +12 -0
- package/dist/components/callout.d.ts.map +1 -0
- package/dist/components/callout.js +7 -0
- package/dist/components/code-block-tabs.d.ts +7 -0
- package/dist/components/code-block-tabs.d.ts.map +1 -0
- package/dist/components/code-block-tabs.js +7 -0
- package/dist/components/code-block.d.ts +14 -0
- package/dist/components/code-block.d.ts.map +1 -0
- package/dist/components/code-block.js +45 -0
- package/dist/components/copy-prompt.d.ts +11 -0
- package/dist/components/copy-prompt.d.ts.map +1 -0
- package/dist/components/copy-prompt.js +58 -0
- package/dist/components/mermaid.d.ts +4 -0
- package/dist/components/mermaid.d.ts.map +1 -0
- package/dist/components/mermaid.js +44 -0
- package/dist/components/theme-aware-image.d.ts +12 -0
- package/dist/components/theme-aware-image.d.ts.map +1 -0
- package/dist/components/theme-aware-image.js +8 -0
- package/dist/components/video.d.ts +6 -0
- package/dist/components/video.d.ts.map +1 -0
- package/dist/components/video.js +3 -0
- package/dist/config.d.ts +71 -0
- package/dist/config.d.ts.map +1 -0
- package/dist/config.js +1 -0
- package/dist/controls.d.ts +15 -0
- package/dist/controls.d.ts.map +1 -0
- package/dist/controls.js +52 -0
- package/dist/internal/chat/context.d.ts +19 -0
- package/dist/internal/chat/context.d.ts.map +1 -0
- package/dist/internal/chat/context.js +36 -0
- package/dist/internal/chat/conversation.d.ts +10 -0
- package/dist/internal/chat/conversation.d.ts.map +1 -0
- package/dist/internal/chat/conversation.js +16 -0
- package/dist/internal/chat/copy-chat.d.ts +5 -0
- package/dist/internal/chat/copy-chat.d.ts.map +1 -0
- package/dist/internal/chat/copy-chat.js +35 -0
- package/dist/internal/chat/db.d.ts +13 -0
- package/dist/internal/chat/db.d.ts.map +1 -0
- package/dist/internal/chat/db.js +19 -0
- package/dist/internal/chat/message-metadata.d.ts +8 -0
- package/dist/internal/chat/message-metadata.d.ts.map +1 -0
- package/dist/internal/chat/message-metadata.js +29 -0
- package/dist/internal/chat/message.d.ts +11 -0
- package/dist/internal/chat/message.d.ts.map +1 -0
- package/dist/internal/chat/message.js +11 -0
- package/dist/internal/chat/prompt-input.d.ts +13 -0
- package/dist/internal/chat/prompt-input.d.ts.map +1 -0
- package/dist/internal/chat/prompt-input.js +39 -0
- package/dist/internal/chat/shell.d.ts +2 -0
- package/dist/internal/chat/shell.d.ts.map +1 -0
- package/dist/internal/chat/shell.js +194 -0
- package/dist/internal/chat/shimmer.d.ts +11 -0
- package/dist/internal/chat/shimmer.d.ts.map +1 -0
- package/dist/internal/chat/shimmer.js +18 -0
- package/dist/internal/chat/sources.d.ts +13 -0
- package/dist/internal/chat/sources.d.ts.map +1 -0
- package/dist/internal/chat/sources.js +9 -0
- package/dist/internal/chat/suggestion.d.ts +11 -0
- package/dist/internal/chat/suggestion.d.ts.map +1 -0
- package/dist/internal/chat/suggestion.js +12 -0
- package/dist/internal/cn.d.ts +3 -0
- package/dist/internal/cn.d.ts.map +1 -0
- package/dist/internal/cn.js +3 -0
- package/dist/internal/feedback-action.d.ts +14 -0
- package/dist/internal/feedback-action.d.ts.map +1 -0
- package/dist/internal/feedback-action.js +34 -0
- package/dist/internal/i18n.d.ts +6 -0
- package/dist/internal/i18n.d.ts.map +1 -0
- package/dist/internal/i18n.js +18 -0
- package/dist/internal/languages.d.ts +7 -0
- package/dist/internal/languages.d.ts.map +1 -0
- package/dist/internal/languages.js +18 -0
- package/dist/internal/not-implemented.d.ts +2 -0
- package/dist/internal/not-implemented.d.ts.map +1 -0
- package/dist/internal/not-implemented.js +4 -0
- package/dist/internal/page-actions-client.d.ts +13 -0
- package/dist/internal/page-actions-client.d.ts.map +1 -0
- package/dist/internal/page-actions-client.js +160 -0
- package/dist/internal/page-actions.d.ts +18 -0
- package/dist/internal/page-actions.d.ts.map +1 -0
- package/dist/internal/page-actions.js +4 -0
- package/dist/internal/provider-client.d.ts +9 -0
- package/dist/internal/provider-client.d.ts.map +1 -0
- package/dist/internal/provider-client.js +23 -0
- package/dist/internal/search.d.ts +5 -0
- package/dist/internal/search.d.ts.map +1 -0
- package/dist/internal/search.js +14 -0
- package/dist/internal/sidebar.d.ts +9 -0
- package/dist/internal/sidebar.d.ts.map +1 -0
- package/dist/internal/sidebar.js +38 -0
- package/dist/internal/table-of-contents.d.ts +9 -0
- package/dist/internal/table-of-contents.d.ts.map +1 -0
- package/dist/internal/table-of-contents.js +5 -0
- package/dist/internal/ui/button-group.d.ts +13 -0
- package/dist/internal/ui/button-group.d.ts.map +1 -0
- package/dist/internal/ui/button-group.js +26 -0
- package/dist/internal/ui/button.d.ts +12 -0
- package/dist/internal/ui/button.d.ts.map +1 -0
- package/dist/internal/ui/button.js +33 -0
- package/dist/internal/ui/card.d.ts +6 -0
- package/dist/internal/ui/card.d.ts.map +1 -0
- package/dist/internal/ui/card.js +14 -0
- package/dist/internal/ui/collapsible.d.ts +6 -0
- package/dist/internal/ui/collapsible.d.ts.map +1 -0
- package/dist/internal/ui/collapsible.js +12 -0
- package/dist/internal/ui/drawer.d.ts +6 -0
- package/dist/internal/ui/drawer.d.ts.map +1 -0
- package/dist/internal/ui/drawer.js +13 -0
- package/dist/internal/ui/dropdown-menu.d.ts +22 -0
- package/dist/internal/ui/dropdown-menu.d.ts.map +1 -0
- package/dist/internal/ui/dropdown-menu.js +41 -0
- package/dist/internal/ui/input-group.d.ts +15 -0
- package/dist/internal/ui/input-group.d.ts.map +1 -0
- package/dist/internal/ui/input-group.js +44 -0
- package/dist/internal/ui/input.d.ts +3 -0
- package/dist/internal/ui/input.d.ts.map +1 -0
- package/dist/internal/ui/input.js +5 -0
- package/dist/internal/ui/kbd.d.ts +4 -0
- package/dist/internal/ui/kbd.d.ts.map +1 -0
- package/dist/internal/ui/kbd.js +8 -0
- package/dist/internal/ui/popover.d.ts +6 -0
- package/dist/internal/ui/popover.d.ts.map +1 -0
- package/dist/internal/ui/popover.js +13 -0
- package/dist/internal/ui/scroll-area.d.ts +5 -0
- package/dist/internal/ui/scroll-area.d.ts.map +1 -0
- package/dist/internal/ui/scroll-area.js +12 -0
- package/dist/internal/ui/separator.d.ts +4 -0
- package/dist/internal/ui/separator.d.ts.map +1 -0
- package/dist/internal/ui/separator.js +7 -0
- package/dist/internal/ui/sheet.d.ts +10 -0
- package/dist/internal/ui/sheet.d.ts.map +1 -0
- package/dist/internal/ui/sheet.js +24 -0
- package/dist/internal/ui/sonner.d.ts +3 -0
- package/dist/internal/ui/sonner.d.ts.map +1 -0
- package/dist/internal/ui/sonner.js +20 -0
- package/dist/internal/ui/spinner.d.ts +3 -0
- package/dist/internal/ui/spinner.d.ts.map +1 -0
- package/dist/internal/ui/spinner.js +6 -0
- package/dist/internal/ui/textarea.d.ts +3 -0
- package/dist/internal/ui/textarea.d.ts.map +1 -0
- package/dist/internal/ui/textarea.js +5 -0
- package/dist/internal/ui/tooltip.d.ts +7 -0
- package/dist/internal/ui/tooltip.d.ts.map +1 -0
- package/dist/internal/ui/tooltip.js +16 -0
- package/dist/internal/use-mobile.d.ts +2 -0
- package/dist/internal/use-mobile.d.ts.map +1 -0
- package/dist/internal/use-mobile.js +16 -0
- package/dist/layout.d.ts +14 -0
- package/dist/layout.d.ts.map +1 -0
- package/dist/layout.js +31 -0
- package/dist/mdx.d.ts +36 -0
- package/dist/mdx.d.ts.map +1 -0
- package/dist/mdx.js +80 -0
- package/dist/pages/docs.d.ts +77 -0
- package/dist/pages/docs.d.ts.map +1 -0
- package/dist/pages/docs.js +92 -0
- package/dist/proxy.d.ts +37 -0
- package/dist/proxy.d.ts.map +1 -0
- package/dist/proxy.js +162 -0
- package/dist/routes/chat.d.ts +14 -0
- package/dist/routes/chat.d.ts.map +1 -0
- package/dist/routes/chat.js +242 -0
- package/dist/routes/llms.d.ts +51 -0
- package/dist/routes/llms.d.ts.map +1 -0
- package/dist/routes/llms.js +59 -0
- package/dist/routes/search.d.ts +11 -0
- package/dist/routes/search.d.ts.map +1 -0
- package/dist/routes/search.js +74 -0
- package/dist/routes/sitemap.d.ts +44 -0
- package/dist/routes/sitemap.d.ts.map +1 -0
- package/dist/routes/sitemap.js +168 -0
- package/dist/shiki-theme.d.ts +20 -0
- package/dist/shiki-theme.d.ts.map +1 -0
- package/dist/shiki-theme.js +110 -0
- package/dist/sidebar.d.ts +11 -0
- package/dist/sidebar.d.ts.map +1 -0
- package/dist/sidebar.js +16 -0
- package/dist/source.d.ts +174 -0
- package/dist/source.d.ts.map +1 -0
- package/dist/source.js +129 -0
- package/dist/versions.d.ts +15 -0
- package/dist/versions.d.ts.map +1 -0
- package/dist/versions.js +52 -0
- package/package.json +161 -9
- package/styles.css +556 -0
- package/template/_gitignore +29 -0
- package/template/app/[lang]/(home)/components/centered-section.tsx +24 -0
- package/template/app/[lang]/(home)/components/cta.tsx +19 -0
- package/template/app/[lang]/(home)/components/hero.tsx +27 -0
- package/template/app/[lang]/(home)/components/one-two-section.tsx +23 -0
- package/template/app/[lang]/(home)/components/templates.tsx +48 -0
- package/template/app/[lang]/(home)/components/text-grid-section.tsx +20 -0
- package/template/app/[lang]/(home)/layout.tsx +14 -0
- package/template/app/[lang]/(home)/page.tsx +126 -0
- package/template/app/[lang]/docs/[[...slug]]/page.tsx +19 -0
- package/template/app/[lang]/docs/layout.tsx +14 -0
- package/template/app/[lang]/layout.tsx +29 -0
- package/template/app/[lang]/llms.mdx/[[...slug]]/route.ts +7 -0
- package/template/app/[lang]/llms.txt/route.ts +6 -0
- package/template/app/[lang]/og/[...slug]/background.png +0 -0
- package/template/app/[lang]/og/[...slug]/geist-sans-regular.ttf +0 -0
- package/template/app/[lang]/og/[...slug]/geist-sans-semibold.ttf +0 -0
- package/template/app/[lang]/og/[...slug]/route.tsx +95 -0
- package/template/app/[lang]/rss.xml/route.ts +52 -0
- package/template/app/[lang]/sitemap.md/route.ts +9 -0
- package/template/app/actions/feedback/emotions.ts +18 -0
- package/template/app/actions/feedback/index.ts +45 -0
- package/template/app/api/chat/route.ts +8 -0
- package/template/app/api/search/route.ts +5 -0
- package/template/app/favicon.ico +0 -0
- package/template/app/global.css +2 -0
- package/template/app/robots.ts +14 -0
- package/template/app/sitemap.ts +36 -0
- package/template/app/styles/geistdocs.css +595 -0
- package/template/components/geistdocs/chat.tsx +24 -0
- package/template/components/geistdocs/desktop-menu.tsx +52 -0
- package/template/components/geistdocs/docs-layout.tsx +20 -0
- package/template/components/geistdocs/feedback.tsx +139 -0
- package/template/components/geistdocs/footer.tsx +30 -0
- package/template/components/geistdocs/github-button.tsx +19 -0
- package/template/components/geistdocs/home-layout.tsx +46 -0
- package/template/components/geistdocs/language-selector.tsx +3 -0
- package/template/components/geistdocs/mdx-components.tsx +5 -0
- package/template/components/geistdocs/mobile-docs-bar.tsx +77 -0
- package/template/components/geistdocs/mobile-menu.tsx +150 -0
- package/template/components/geistdocs/navbar-logo.tsx +124 -0
- package/template/components/geistdocs/navbar.tsx +22 -0
- package/template/components/geistdocs/provider.tsx +31 -0
- package/template/components/geistdocs/rss-button.tsx +10 -0
- package/template/components/geistdocs/search.tsx +17 -0
- package/template/components/geistdocs/sidebar.tsx +128 -0
- package/template/components/geistdocs/theme-aware-image.tsx +22 -0
- package/template/components/geistdocs/theme-toggle.tsx +3 -0
- package/template/components/ui/badge.tsx +46 -0
- package/template/components/ui/button.tsx +60 -0
- package/template/components/ui/card.tsx +92 -0
- package/template/components/ui/command-prompt.tsx +488 -0
- package/template/components/ui/dialog.tsx +143 -0
- package/template/components/ui/input-group.tsx +170 -0
- package/template/components/ui/input.tsx +21 -0
- package/template/components/ui/navigation-menu.tsx +192 -0
- package/template/components/ui/popover.tsx +48 -0
- package/template/components/ui/separator.tsx +28 -0
- package/template/components/ui/sheet.tsx +139 -0
- package/template/components/ui/textarea.tsx +18 -0
- package/template/components.json +22 -0
- package/template/content/docs/ask-ai.cn.mdx +85 -0
- package/template/content/docs/ask-ai.mdx +89 -0
- package/template/content/docs/configuration.cn.mdx +155 -0
- package/template/content/docs/configuration.mdx +200 -0
- package/template/content/docs/deployment.cn.mdx +34 -0
- package/template/content/docs/deployment.mdx +40 -0
- package/template/content/docs/edit-on-github.cn.mdx +47 -0
- package/template/content/docs/edit-on-github.mdx +51 -0
- package/template/content/docs/env.cn.mdx +25 -0
- package/template/content/docs/env.mdx +29 -0
- package/template/content/docs/feedback.cn.mdx +85 -0
- package/template/content/docs/feedback.mdx +89 -0
- package/template/content/docs/getting-started.cn.mdx +86 -0
- package/template/content/docs/getting-started.mdx +107 -0
- package/template/content/docs/index.cn.mdx +57 -0
- package/template/content/docs/index.mdx +92 -0
- package/template/content/docs/internationalization.cn.mdx +111 -0
- package/template/content/docs/internationalization.mdx +122 -0
- package/template/content/docs/llms-txt.cn.mdx +72 -0
- package/template/content/docs/llms-txt.mdx +85 -0
- package/template/content/docs/md.cn.mdx +65 -0
- package/template/content/docs/md.mdx +81 -0
- package/template/content/docs/meta.json +23 -0
- package/template/content/docs/open-in-chat.cn.mdx +78 -0
- package/template/content/docs/open-in-chat.mdx +80 -0
- package/template/content/docs/provider.cn.mdx +70 -0
- package/template/content/docs/provider.mdx +74 -0
- package/template/content/docs/proxy.cn.mdx +96 -0
- package/template/content/docs/proxy.mdx +124 -0
- package/template/content/docs/rss.cn.mdx +104 -0
- package/template/content/docs/rss.mdx +108 -0
- package/template/content/docs/syntax.cn.mdx +416 -0
- package/template/content/docs/syntax.mdx +411 -0
- package/template/content/docs/theme-aware-image.mdx +57 -0
- package/template/content/docs/versioned-docs.cn.mdx +117 -0
- package/template/content/docs/versioned-docs.mdx +181 -0
- package/template/geistdocs.tsx +51 -0
- package/template/hooks/geistdocs/use-sidebar.ts +13 -0
- package/template/hooks/use-mobile.ts +19 -0
- package/template/lib/geistdocs/config.tsx +27 -0
- package/template/lib/geistdocs/fonts.ts +18 -0
- package/template/lib/geistdocs/i18n.ts +13 -0
- package/template/lib/geistdocs/md-tracking.ts +56 -0
- package/template/lib/geistdocs/source.ts +12 -0
- package/template/lib/utils.ts +6 -0
- package/template/next.config.ts +22 -0
- package/template/package.json +63 -0
- package/template/postcss.config.mjs +5 -0
- package/template/proxy.ts +18 -0
- package/template/source.config.ts +179 -0
- package/template/tsconfig.json +37 -0
- package/dist/index.js +0 -2
- /package/dist/{index.d.ts → cli/index.d.ts} +0 -0
|
@@ -0,0 +1,181 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Versioned docs
|
|
3
|
+
description: Configure multiple documentation versions with package-backed source helpers
|
|
4
|
+
type: guide
|
|
5
|
+
summary: Use createVersionedSources to configure stable, pre-release, or host-based documentation versions.
|
|
6
|
+
prerequisites:
|
|
7
|
+
- /docs/configuration
|
|
8
|
+
related:
|
|
9
|
+
- /docs/proxy
|
|
10
|
+
- /docs/llms-txt
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
Versioned docs let you serve multiple documentation sets from one Geistdocs project. Use them for stable and pre-release docs, previous major versions, or host-based version switching.
|
|
14
|
+
|
|
15
|
+
<CopyPrompt text="Help me add versioned docs to this Geistdocs site. Inspect source.config.ts, lib/geistdocs/source.ts, app route files, and the docs layout, then propose a versioned source setup using createVersionedSources.">
|
|
16
|
+
Help me add versioned docs to this Geistdocs site. Inspect `source.config.ts`, `lib/geistdocs/source.ts`, app route files, and the docs layout, then propose a versioned source setup using `createVersionedSources`.
|
|
17
|
+
</CopyPrompt>
|
|
18
|
+
|
|
19
|
+
## Configure source collections
|
|
20
|
+
|
|
21
|
+
Create one Fumadocs collection for each version in `source.config.ts`:
|
|
22
|
+
|
|
23
|
+
```ts title="source.config.ts"
|
|
24
|
+
import { defineConfig, defineDocs } from "fumadocs-mdx/config";
|
|
25
|
+
|
|
26
|
+
export const v4docs = defineDocs({
|
|
27
|
+
dir: "content/docs/v4",
|
|
28
|
+
docs: {
|
|
29
|
+
postprocess: {
|
|
30
|
+
includeProcessedMarkdown: true,
|
|
31
|
+
},
|
|
32
|
+
},
|
|
33
|
+
});
|
|
34
|
+
|
|
35
|
+
export const v5docs = defineDocs({
|
|
36
|
+
dir: "content/docs/v5",
|
|
37
|
+
docs: {
|
|
38
|
+
postprocess: {
|
|
39
|
+
includeProcessedMarkdown: true,
|
|
40
|
+
},
|
|
41
|
+
},
|
|
42
|
+
});
|
|
43
|
+
|
|
44
|
+
export default defineConfig({});
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Create versioned sources
|
|
48
|
+
|
|
49
|
+
Use `createVersionedSources` in `lib/geistdocs/source.ts`:
|
|
50
|
+
|
|
51
|
+
```ts title="lib/geistdocs/source.ts"
|
|
52
|
+
import { createVersionedSources } from "@vercel/geistdocs/source";
|
|
53
|
+
import { v4docs, v5docs } from "@/.source/server";
|
|
54
|
+
import { config } from "./config";
|
|
55
|
+
|
|
56
|
+
export const versions = createVersionedSources({
|
|
57
|
+
config,
|
|
58
|
+
current: "v4",
|
|
59
|
+
versions: [
|
|
60
|
+
{
|
|
61
|
+
id: "v4",
|
|
62
|
+
label: "v4",
|
|
63
|
+
docs: v4docs,
|
|
64
|
+
baseUrl: "/docs",
|
|
65
|
+
},
|
|
66
|
+
{
|
|
67
|
+
id: "v5",
|
|
68
|
+
label: "v5 pre-release",
|
|
69
|
+
docs: v5docs,
|
|
70
|
+
baseUrl: "/docs",
|
|
71
|
+
routePrefix: "/v5",
|
|
72
|
+
},
|
|
73
|
+
],
|
|
74
|
+
});
|
|
75
|
+
|
|
76
|
+
export const geistdocsSource = versions.current;
|
|
77
|
+
export const source = geistdocsSource.source;
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
The returned object includes:
|
|
81
|
+
|
|
82
|
+
| Property | Type | Description |
|
|
83
|
+
| --- | --- | --- |
|
|
84
|
+
| `current` | `GeistdocsSourceBundle` | The source matching the `current` version ID. |
|
|
85
|
+
| `byId` | `Record<string, GeistdocsSourceBundle>` | A map of version IDs to source bundles. |
|
|
86
|
+
| `all` | `Array` | Version metadata and source bundles for rendering UI. |
|
|
87
|
+
| `currentVersion` | `string` | The active version ID. |
|
|
88
|
+
|
|
89
|
+
## Render versioned pages
|
|
90
|
+
|
|
91
|
+
Use the current version for `/docs` and a specific version for version-prefixed routes:
|
|
92
|
+
|
|
93
|
+
```tsx title="app/[lang]/docs/[[...slug]]/page.tsx"
|
|
94
|
+
import { createDocsPage } from "@vercel/geistdocs/pages/docs";
|
|
95
|
+
import { config } from "@/lib/geistdocs/config";
|
|
96
|
+
import { versions } from "@/lib/geistdocs/source";
|
|
97
|
+
|
|
98
|
+
const docsPage = createDocsPage({
|
|
99
|
+
config,
|
|
100
|
+
source: versions.current,
|
|
101
|
+
});
|
|
102
|
+
|
|
103
|
+
export default docsPage.Page;
|
|
104
|
+
export const generateStaticParams = docsPage.generateStaticParams;
|
|
105
|
+
export const generateMetadata = docsPage.generateMetadata;
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
```tsx title="app/[lang]/v5/docs/[[...slug]]/page.tsx"
|
|
109
|
+
import { createDocsPage } from "@vercel/geistdocs/pages/docs";
|
|
110
|
+
import { config } from "@/lib/geistdocs/config";
|
|
111
|
+
import { versions } from "@/lib/geistdocs/source";
|
|
112
|
+
|
|
113
|
+
const docsPage = createDocsPage({
|
|
114
|
+
config,
|
|
115
|
+
source: versions.byId.v5,
|
|
116
|
+
getPageUrl: ({ page }) => `/v5${page.url}`,
|
|
117
|
+
metadata: ({ metadata }) => ({
|
|
118
|
+
...metadata,
|
|
119
|
+
robots: {
|
|
120
|
+
index: false,
|
|
121
|
+
follow: true,
|
|
122
|
+
},
|
|
123
|
+
}),
|
|
124
|
+
});
|
|
125
|
+
|
|
126
|
+
export default docsPage.Page;
|
|
127
|
+
export const generateStaticParams = docsPage.generateStaticParams;
|
|
128
|
+
export const generateMetadata = docsPage.generateMetadata;
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
Use `getPageUrl` when the route path differs from the source `baseUrl`. This keeps page actions and markdown links pointed at the public URL.
|
|
132
|
+
|
|
133
|
+
## Add a version selector
|
|
134
|
+
|
|
135
|
+
Use `GeistdocsVersionSelect` when readers need to move between versions:
|
|
136
|
+
|
|
137
|
+
```tsx title="components/geistdocs/docs-layout.tsx"
|
|
138
|
+
import { GeistdocsDocsLayout } from "@vercel/geistdocs/layout";
|
|
139
|
+
import { GeistdocsVersionSelect } from "@vercel/geistdocs/versions";
|
|
140
|
+
import { config } from "@/lib/geistdocs/config";
|
|
141
|
+
|
|
142
|
+
export const DocsLayout = ({ tree, children }: DocsLayoutProps) => (
|
|
143
|
+
<GeistdocsDocsLayout
|
|
144
|
+
config={config}
|
|
145
|
+
sidebarTop={
|
|
146
|
+
<GeistdocsVersionSelect
|
|
147
|
+
current="v4"
|
|
148
|
+
versions={[
|
|
149
|
+
{ id: "v4", label: "v4" },
|
|
150
|
+
{ id: "v5", label: "v5 pre-release", routePrefix: "/v5" },
|
|
151
|
+
]}
|
|
152
|
+
/>
|
|
153
|
+
}
|
|
154
|
+
tree={tree}
|
|
155
|
+
>
|
|
156
|
+
{children}
|
|
157
|
+
</GeistdocsDocsLayout>
|
|
158
|
+
);
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
For host-based versions, use `href` instead of `routePrefix`:
|
|
162
|
+
|
|
163
|
+
```tsx
|
|
164
|
+
<GeistdocsVersionSelect
|
|
165
|
+
current="v6"
|
|
166
|
+
versions={[
|
|
167
|
+
{ id: "v6", label: "v6 latest" },
|
|
168
|
+
{ id: "v5", label: "v5", href: "https://v5.example.com/:path*" },
|
|
169
|
+
{ id: "v4", label: "v4", href: "https://v4.example.com/:path*" },
|
|
170
|
+
]}
|
|
171
|
+
/>
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
## Configure markdown routes
|
|
175
|
+
|
|
176
|
+
Each public route family needs a matching markdown route in `proxy.ts`. Read [Proxy and markdown routes](/docs/proxy) for the proxy configuration.
|
|
177
|
+
|
|
178
|
+
## Next steps
|
|
179
|
+
|
|
180
|
+
- Read [Proxy and markdown routes](/docs/proxy) to connect versioned pages to `.md`, `.mdx`, and AI-agent rewrites.
|
|
181
|
+
- Read [llms.txt](/docs/llms-txt) to configure all-docs markdown output for multiple sources.
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
export const Logo = () => (
|
|
2
|
+
<span className="font-semibold text-gray-1000 text-lg leading-none tracking-[-3%]">
|
|
3
|
+
Geistdocs
|
|
4
|
+
</span>
|
|
5
|
+
);
|
|
6
|
+
|
|
7
|
+
export const github = {
|
|
8
|
+
owner: "vercel",
|
|
9
|
+
repo: "geistdocs",
|
|
10
|
+
};
|
|
11
|
+
|
|
12
|
+
export const nav = [
|
|
13
|
+
{
|
|
14
|
+
label: "Docs",
|
|
15
|
+
href: "/docs",
|
|
16
|
+
},
|
|
17
|
+
{
|
|
18
|
+
label: "Source",
|
|
19
|
+
href: `https://github.com/${github.owner}/${github.repo}/`,
|
|
20
|
+
},
|
|
21
|
+
];
|
|
22
|
+
|
|
23
|
+
export const suggestions = [
|
|
24
|
+
"What is Geistdocs?",
|
|
25
|
+
"What can I make with Geistdocs?",
|
|
26
|
+
"What syntax does Geistdocs support?",
|
|
27
|
+
"How do I deploy my Geistdocs site?",
|
|
28
|
+
];
|
|
29
|
+
|
|
30
|
+
export const title = "Geistdocs Documentation";
|
|
31
|
+
|
|
32
|
+
export const prompt =
|
|
33
|
+
"You are a helpful assistant specializing in answering questions about Geistdocs, a modern documentation template built with Next.js and Fumadocs.";
|
|
34
|
+
|
|
35
|
+
export const translations = {
|
|
36
|
+
en: {
|
|
37
|
+
displayName: "English",
|
|
38
|
+
},
|
|
39
|
+
cn: {
|
|
40
|
+
displayName: "Chinese",
|
|
41
|
+
search: "搜尋文檔",
|
|
42
|
+
},
|
|
43
|
+
};
|
|
44
|
+
|
|
45
|
+
export const basePath: string | undefined = undefined;
|
|
46
|
+
|
|
47
|
+
/**
|
|
48
|
+
* Unique identifier for this site, used in markdown request tracking analytics.
|
|
49
|
+
* Each site using geistdocs should set this to a unique value (e.g. "ai-sdk-docs", "next-docs").
|
|
50
|
+
*/
|
|
51
|
+
export const siteId: string | undefined = undefined;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { atom, useAtom } from "jotai";
|
|
2
|
+
|
|
3
|
+
// Export the sidebar open state atom so it can be used from other parts of the app
|
|
4
|
+
export const sidebarOpenAtom = atom<boolean>(false);
|
|
5
|
+
|
|
6
|
+
export const useSidebarContext = () => {
|
|
7
|
+
const [isOpen, setIsOpen] = useAtom(sidebarOpenAtom);
|
|
8
|
+
|
|
9
|
+
return {
|
|
10
|
+
isOpen,
|
|
11
|
+
setIsOpen,
|
|
12
|
+
};
|
|
13
|
+
};
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import * as React from "react"
|
|
2
|
+
|
|
3
|
+
const MOBILE_BREAKPOINT = 768
|
|
4
|
+
|
|
5
|
+
export function useIsMobile() {
|
|
6
|
+
const [isMobile, setIsMobile] = React.useState<boolean | undefined>(undefined)
|
|
7
|
+
|
|
8
|
+
React.useEffect(() => {
|
|
9
|
+
const mql = window.matchMedia(`(max-width: ${MOBILE_BREAKPOINT - 1}px)`)
|
|
10
|
+
const onChange = () => {
|
|
11
|
+
setIsMobile(window.innerWidth < MOBILE_BREAKPOINT)
|
|
12
|
+
}
|
|
13
|
+
mql.addEventListener("change", onChange)
|
|
14
|
+
setIsMobile(window.innerWidth < MOBILE_BREAKPOINT)
|
|
15
|
+
return () => mql.removeEventListener("change", onChange)
|
|
16
|
+
}, [])
|
|
17
|
+
|
|
18
|
+
return !!isMobile
|
|
19
|
+
}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { defineConfig } from "@vercel/geistdocs/config";
|
|
2
|
+
import {
|
|
3
|
+
basePath,
|
|
4
|
+
github,
|
|
5
|
+
Logo,
|
|
6
|
+
nav,
|
|
7
|
+
prompt,
|
|
8
|
+
siteId,
|
|
9
|
+
suggestions,
|
|
10
|
+
title,
|
|
11
|
+
translations,
|
|
12
|
+
} from "@/geistdocs";
|
|
13
|
+
|
|
14
|
+
export const config = defineConfig({
|
|
15
|
+
title,
|
|
16
|
+
defaultLanguage: "en",
|
|
17
|
+
logo: <Logo />,
|
|
18
|
+
github,
|
|
19
|
+
nav,
|
|
20
|
+
basePath,
|
|
21
|
+
siteId,
|
|
22
|
+
translations,
|
|
23
|
+
ai: {
|
|
24
|
+
prompt,
|
|
25
|
+
suggestions,
|
|
26
|
+
},
|
|
27
|
+
});
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import {
|
|
2
|
+
Geist_Mono as createMono,
|
|
3
|
+
Geist as createSans,
|
|
4
|
+
} from "next/font/google";
|
|
5
|
+
|
|
6
|
+
export const sans = createSans({
|
|
7
|
+
variable: "--font-sans",
|
|
8
|
+
subsets: ["latin"],
|
|
9
|
+
weight: "variable",
|
|
10
|
+
display: "swap",
|
|
11
|
+
});
|
|
12
|
+
|
|
13
|
+
export const mono = createMono({
|
|
14
|
+
variable: "--font-mono",
|
|
15
|
+
subsets: ["latin"],
|
|
16
|
+
weight: "variable",
|
|
17
|
+
display: "swap",
|
|
18
|
+
});
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { defineI18n } from "fumadocs-core/i18n";
|
|
2
|
+
import { defineI18nUI } from "fumadocs-ui/i18n";
|
|
3
|
+
import { translations } from "@/geistdocs";
|
|
4
|
+
|
|
5
|
+
export const i18n = defineI18n({
|
|
6
|
+
defaultLanguage: "en",
|
|
7
|
+
languages: Object.keys(translations),
|
|
8
|
+
hideLocale: "default-locale",
|
|
9
|
+
});
|
|
10
|
+
|
|
11
|
+
export const { provider: i18nProvider } = defineI18nUI(i18n, {
|
|
12
|
+
translations,
|
|
13
|
+
});
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import type { DetectionMethod } from "@vercel/agent-readability";
|
|
2
|
+
import { siteId } from "@/geistdocs";
|
|
3
|
+
|
|
4
|
+
const PLATFORM_URL = "https://geistdocs.com/md-tracking";
|
|
5
|
+
|
|
6
|
+
interface TrackMdRequestParams {
|
|
7
|
+
acceptHeader: string | null;
|
|
8
|
+
/** Detection method used to identify the agent (only for agent-rewrite requests) */
|
|
9
|
+
detectionMethod?: DetectionMethod | null;
|
|
10
|
+
path: string;
|
|
11
|
+
referer: string | null;
|
|
12
|
+
/** How the markdown was requested: 'md-url' for direct .md URLs, 'header-negotiated' for Accept header, 'agent-rewrite' for detected AI agents */
|
|
13
|
+
requestType?: "md-url" | "header-negotiated" | "agent-rewrite";
|
|
14
|
+
userAgent: string | null;
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* Track a markdown page request via the geistdocs platform.
|
|
19
|
+
* Fire-and-forget: errors are logged but don't affect the response.
|
|
20
|
+
*/
|
|
21
|
+
export async function trackMdRequest({
|
|
22
|
+
path,
|
|
23
|
+
userAgent,
|
|
24
|
+
referer,
|
|
25
|
+
acceptHeader,
|
|
26
|
+
requestType,
|
|
27
|
+
detectionMethod,
|
|
28
|
+
}: TrackMdRequestParams): Promise<void> {
|
|
29
|
+
try {
|
|
30
|
+
const response = await fetch(PLATFORM_URL, {
|
|
31
|
+
method: "POST",
|
|
32
|
+
headers: {
|
|
33
|
+
"Content-Type": "application/json",
|
|
34
|
+
},
|
|
35
|
+
body: JSON.stringify({
|
|
36
|
+
path,
|
|
37
|
+
siteId: siteId ?? "geistdocs-unknown",
|
|
38
|
+
userAgent,
|
|
39
|
+
referer,
|
|
40
|
+
acceptHeader,
|
|
41
|
+
requestType,
|
|
42
|
+
detectionMethod,
|
|
43
|
+
}),
|
|
44
|
+
});
|
|
45
|
+
|
|
46
|
+
if (!response.ok) {
|
|
47
|
+
console.error(
|
|
48
|
+
"MD tracking failed:",
|
|
49
|
+
response.status,
|
|
50
|
+
await response.text()
|
|
51
|
+
);
|
|
52
|
+
}
|
|
53
|
+
} catch (error) {
|
|
54
|
+
console.error("MD tracking error:", error);
|
|
55
|
+
}
|
|
56
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { createSource } from "@vercel/geistdocs/source";
|
|
2
|
+
import { docs } from "@/.source/server";
|
|
3
|
+
import { config } from "./config";
|
|
4
|
+
|
|
5
|
+
export const geistdocsSource = createSource({
|
|
6
|
+
docs,
|
|
7
|
+
config,
|
|
8
|
+
});
|
|
9
|
+
|
|
10
|
+
export const source = geistdocsSource.source;
|
|
11
|
+
export const getPageImage = geistdocsSource.getPageImage;
|
|
12
|
+
export const getLLMText = geistdocsSource.getPageMarkdown;
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { createMDX } from "fumadocs-mdx/next";
|
|
2
|
+
import type { NextConfig } from "next";
|
|
3
|
+
|
|
4
|
+
const withMDX = createMDX();
|
|
5
|
+
|
|
6
|
+
const config: NextConfig = {
|
|
7
|
+
experimental: {
|
|
8
|
+
turbopackFileSystemCacheForDev: true,
|
|
9
|
+
},
|
|
10
|
+
|
|
11
|
+
images: {
|
|
12
|
+
formats: ["image/avif", "image/webp"],
|
|
13
|
+
remotePatterns: [
|
|
14
|
+
{
|
|
15
|
+
protocol: "https",
|
|
16
|
+
hostname: "placehold.co",
|
|
17
|
+
},
|
|
18
|
+
],
|
|
19
|
+
},
|
|
20
|
+
};
|
|
21
|
+
|
|
22
|
+
export default withMDX(config);
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "template",
|
|
3
|
+
"description": "Template for Geistdocs projects.",
|
|
4
|
+
"version": "0.0.0",
|
|
5
|
+
"private": true,
|
|
6
|
+
"scripts": {
|
|
7
|
+
"build": "next build",
|
|
8
|
+
"dev": "next dev",
|
|
9
|
+
"start": "next start",
|
|
10
|
+
"postinstall": "fumadocs-mdx",
|
|
11
|
+
"translate": "npx @vercel/geistdocs translate"
|
|
12
|
+
},
|
|
13
|
+
"dependencies": {
|
|
14
|
+
"@ai-sdk/react": "^2.0.115",
|
|
15
|
+
"@icons-pack/react-simple-icons": "^13.8.0",
|
|
16
|
+
"@orama/tokenizers": "^3.1.16",
|
|
17
|
+
"@vercel/geistdocs": "1.2.3-canary.a12a9c6",
|
|
18
|
+
"@streamdown/cjk": "^1.0.1",
|
|
19
|
+
"@streamdown/code": "^1.0.1",
|
|
20
|
+
"@vercel/agent-readability": "^0.2.1",
|
|
21
|
+
"@vercel/analytics": "^1.6.1",
|
|
22
|
+
"@vercel/speed-insights": "^1.3.1",
|
|
23
|
+
"ai": "^5.0.106",
|
|
24
|
+
"class-variance-authority": "^0.7.1",
|
|
25
|
+
"clsx": "^2.1.1",
|
|
26
|
+
"cmdk": "^1.1.1",
|
|
27
|
+
"dexie": "^4.2.1",
|
|
28
|
+
"dexie-react-hooks": "^4.2.0",
|
|
29
|
+
"feed": "^5.1.0",
|
|
30
|
+
"fumadocs-core": "16.2.2",
|
|
31
|
+
"fumadocs-mdx": "14.0.4",
|
|
32
|
+
"fumadocs-ui": "16.2.2",
|
|
33
|
+
"jotai": "^2.15.2",
|
|
34
|
+
"lucide-react": "^0.555.0",
|
|
35
|
+
"mermaid": "^11.12.2",
|
|
36
|
+
"motion": "^12.23.25",
|
|
37
|
+
"nanoid": "^5.1.6",
|
|
38
|
+
"next": "16.0.10",
|
|
39
|
+
"next-themes": "^0.4.6",
|
|
40
|
+
"radix-ui": "latest",
|
|
41
|
+
"react": "^19.2.3",
|
|
42
|
+
"react-dom": "^19.2.3",
|
|
43
|
+
"react-player": "^3.4.0",
|
|
44
|
+
"shiki": "^3.22.0",
|
|
45
|
+
"sonner": "^2.0.7",
|
|
46
|
+
"streamdown": "^2.1.0",
|
|
47
|
+
"tailwind-merge": "^3.4.0",
|
|
48
|
+
"use-stick-to-bottom": "^1.1.1",
|
|
49
|
+
"vaul": "^1.1.2",
|
|
50
|
+
"zod": "^4.1.13"
|
|
51
|
+
},
|
|
52
|
+
"devDependencies": {
|
|
53
|
+
"@tailwindcss/postcss": "^4.1.17",
|
|
54
|
+
"@types/mdx": "^2.0.13",
|
|
55
|
+
"@types/node": "^24.10.1",
|
|
56
|
+
"@types/react": "^19.2.7",
|
|
57
|
+
"@types/react-dom": "^19.2.3",
|
|
58
|
+
"postcss": "^8.5.6",
|
|
59
|
+
"tailwindcss": "^4.1.17",
|
|
60
|
+
"tw-animate-css": "^1.4.0",
|
|
61
|
+
"typescript": "^5.9.3"
|
|
62
|
+
}
|
|
63
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { createProxy } from "@vercel/geistdocs/proxy";
|
|
2
|
+
import { config as geistdocsConfig } from "@/lib/geistdocs/config";
|
|
3
|
+
import { trackMdRequest } from "@/lib/geistdocs/md-tracking";
|
|
4
|
+
|
|
5
|
+
const proxy = createProxy({
|
|
6
|
+
config: geistdocsConfig,
|
|
7
|
+
trackMarkdownRequest: trackMdRequest,
|
|
8
|
+
markdownRoutes: [{ from: "/docs/*path", to: "/[lang]/llms.mdx/*path" }],
|
|
9
|
+
before: () => null,
|
|
10
|
+
});
|
|
11
|
+
|
|
12
|
+
export const config = {
|
|
13
|
+
matcher: [
|
|
14
|
+
"/((?!api|_next/static|_next/image|favicon.ico|sitemap.xml|robots.txt).*)",
|
|
15
|
+
],
|
|
16
|
+
};
|
|
17
|
+
|
|
18
|
+
export default proxy;
|