@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,80 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Open in Chat
|
|
3
|
+
description: Allow users to continue conversations in their preferred AI chat platform with a single click
|
|
4
|
+
type: conceptual
|
|
5
|
+
summary: Transfer documentation context to AI chat platforms like ChatGPT, Claude, Cursor, and v0 with a single click.
|
|
6
|
+
related:
|
|
7
|
+
- /docs/ask-ai
|
|
8
|
+
- /docs/env
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
The "Open in Chat" feature enables users to seamlessly transfer documentation context to their preferred AI assistant. With a single click, users can open the current page in external AI chat platforms like ChatGPT, Claude, v0, Cursor, and more.
|
|
12
|
+
|
|
13
|
+
<CopyPrompt text="Help me test Open in Chat for this Geistdocs site. Verify that page URLs resolve correctly, markdown endpoints work, and each configured AI platform receives useful context.">
|
|
14
|
+
Help me test Open in Chat for this Geistdocs site. Verify that page URLs resolve correctly, markdown endpoints work, and each configured AI platform receives useful context.
|
|
15
|
+
</CopyPrompt>
|
|
16
|
+
|
|
17
|
+
## How it works
|
|
18
|
+
|
|
19
|
+
On every documentation page, users will find an "Open in chat" button in the table of contents sidebar. When clicked, a menu appears with options to open the page in various AI platforms:
|
|
20
|
+
|
|
21
|
+
1. User clicks "Open in chat"
|
|
22
|
+
2. A dropdown menu shows available platforms
|
|
23
|
+
3. User selects their preferred AI assistant
|
|
24
|
+
4. The platform opens with a pre-filled prompt containing the page URL and context
|
|
25
|
+
|
|
26
|
+
The prompt automatically includes:
|
|
27
|
+
|
|
28
|
+
```
|
|
29
|
+
Read this page, I want to ask questions about it. [URL]
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
This allows the AI assistant to fetch and understand the page content before answering user questions.
|
|
33
|
+
|
|
34
|
+
## Supported Platforms
|
|
35
|
+
|
|
36
|
+
The feature integrates with multiple popular AI platforms:
|
|
37
|
+
|
|
38
|
+
### Code & Development Tools
|
|
39
|
+
|
|
40
|
+
- **[Cursor](https://cursor.sh/)** - AI-powered code editor
|
|
41
|
+
- **[v0](https://v0.dev/)** - Vercel's AI interface design tool
|
|
42
|
+
|
|
43
|
+
### General AI Assistants
|
|
44
|
+
|
|
45
|
+
- **[ChatGPT](https://chat.openai.com/)** - OpenAI's conversational AI
|
|
46
|
+
- **[Claude](https://claude.ai/)** - Anthropic's AI assistant
|
|
47
|
+
- **[T3](https://t3.gg/)** - T3 Stack AI assistant
|
|
48
|
+
- **[Scira](https://scira.app/)** - AI-powered documentation assistant
|
|
49
|
+
|
|
50
|
+
## Configuration
|
|
51
|
+
|
|
52
|
+
The environment variable `NEXT_PUBLIC_VERCEL_PROJECT_PRODUCTION_URL` must be set, which you can read more about in the [Environment Variables](/docs/env) section.
|
|
53
|
+
|
|
54
|
+
## User Experience
|
|
55
|
+
|
|
56
|
+
### Desktop Experience
|
|
57
|
+
|
|
58
|
+
The "Open in chat" button appears in the table of contents sidebar with an external link icon. Clicking it reveals a dropdown menu with all available platforms.
|
|
59
|
+
|
|
60
|
+
### Platform-Specific Behavior
|
|
61
|
+
|
|
62
|
+
Each platform has its own integration:
|
|
63
|
+
|
|
64
|
+
- **Browser-based platforms** (ChatGPT, Claude, v0): Open in a new browser tab with the prompt pre-filled
|
|
65
|
+
- **Desktop applications** (Cursor): Open using a custom URL scheme that launches the application
|
|
66
|
+
- **Specialized tools** (T3, Scira): Open with platform-specific parameters and context
|
|
67
|
+
|
|
68
|
+
## Outcomes
|
|
69
|
+
|
|
70
|
+
### For Users
|
|
71
|
+
|
|
72
|
+
1. **Context transfer**: Users do not need to manually copy URLs or switch contexts.
|
|
73
|
+
2. **Consistent starting point**: Each AI platform receives the same page context.
|
|
74
|
+
3. **Tool choice**: Users can open the AI platform they prefer.
|
|
75
|
+
|
|
76
|
+
### For Documentation Authors
|
|
77
|
+
|
|
78
|
+
1. **More support paths**: Users can ask follow-up questions about a page.
|
|
79
|
+
2. **Lower support load**: AI assistants can answer common documentation questions.
|
|
80
|
+
3. **Platform flexibility**: Teams can support different AI preferences.
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Geistdocs 提供者
|
|
3
|
+
description: 处理通知、搜索和分析的根提供者组件
|
|
4
|
+
type: reference
|
|
5
|
+
summary: 包裹应用程序的根提供者组件,处理通知提示、搜索和分析功能。
|
|
6
|
+
prerequisites:
|
|
7
|
+
- /docs/getting-started
|
|
8
|
+
related:
|
|
9
|
+
- /docs/configuration
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
`GeistdocsProvider` 位于应用根部,负责连接主题、搜索、AI chat、通知和可选分析功能。
|
|
13
|
+
|
|
14
|
+
## 它的作用
|
|
15
|
+
|
|
16
|
+
该提供者为您处理以下主要事项:
|
|
17
|
+
|
|
18
|
+
1. **Toast 通知**:提供全局通知系统,用于向用户反馈。
|
|
19
|
+
2. **分析**:当本地 adapter 引入 Vercel Analytics 和 Speed Insights 时,将它们连接到站点。
|
|
20
|
+
3. **搜索**:配置搜索对话框并连接到搜索 API。
|
|
21
|
+
4. **Ask AI**:提供 chat 侧边栏和页面操作所需的客户端状态。
|
|
22
|
+
|
|
23
|
+
## 用法
|
|
24
|
+
|
|
25
|
+
确保在根布局中使用该提供者包裹您的应用:
|
|
26
|
+
|
|
27
|
+
```tsx title="app/layout.tsx"
|
|
28
|
+
import { GeistdocsProvider } from "@/components/geistdocs/provider";
|
|
29
|
+
|
|
30
|
+
const Layout = ({ children }: LayoutProps) => (
|
|
31
|
+
<html lang="en">
|
|
32
|
+
<body>
|
|
33
|
+
<GeistdocsProvider>
|
|
34
|
+
<Navbar />
|
|
35
|
+
{children}
|
|
36
|
+
</GeistdocsProvider>
|
|
37
|
+
</body>
|
|
38
|
+
</html>
|
|
39
|
+
);
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
就这些。提供者会自动处理所有事项。
|
|
43
|
+
|
|
44
|
+
## AI 侧边栏
|
|
45
|
+
|
|
46
|
+
当用户在桌面端打开 AI 聊天时,提供者会自动添加内边距,以防止内容被侧边栏遮挡。在移动端,聊天会以抽屉的形式打开,因此无需内边距。
|
|
47
|
+
|
|
48
|
+
您无需执行任何操作 —— 提供者会自动检测屏幕尺寸和聊天状态。
|
|
49
|
+
|
|
50
|
+
## Toast 通知
|
|
51
|
+
|
|
52
|
+
该提供者包含一个全局的 toast 通知系统。可在应用的任何位置使用:
|
|
53
|
+
|
|
54
|
+
```tsx title="page.tsx"
|
|
55
|
+
import { toast } from "sonner";
|
|
56
|
+
|
|
57
|
+
toast.success("Changes saved");
|
|
58
|
+
toast.error("Something went wrong");
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
## 分析
|
|
62
|
+
|
|
63
|
+
自动包含 Vercel Analytics,并跟踪:
|
|
64
|
+
|
|
65
|
+
- 页面浏览
|
|
66
|
+
- Web Vitals
|
|
67
|
+
- 用户交互
|
|
68
|
+
- 性能指标
|
|
69
|
+
|
|
70
|
+
无需配置 —— 部署到 Vercel 后会自动生效。
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Geistdocs Provider
|
|
3
|
+
description: The root provider component that handles notifications, search and analytics
|
|
4
|
+
type: reference
|
|
5
|
+
summary: The root provider component that wraps your application to handle toast notifications, search, and analytics.
|
|
6
|
+
prerequisites:
|
|
7
|
+
- /docs/getting-started
|
|
8
|
+
related:
|
|
9
|
+
- /docs/configuration
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
The `GeistdocsProvider` wraps the root of your application with package-managed UI state. It connects theme, search, AI chat, notifications, and optional analytics to the rest of your Geistdocs site.
|
|
13
|
+
|
|
14
|
+
<CopyPrompt text="Review my Geistdocs provider setup. Check that the root layout wraps the app with GeistdocsProvider, that config is passed correctly, and that analytics, search, theme, and Ask AI behavior are wired safely.">
|
|
15
|
+
Review my Geistdocs provider setup. Check that the root layout wraps the app with `GeistdocsProvider`, that config is passed correctly, and that analytics, search, theme, and Ask AI behavior are wired safely.
|
|
16
|
+
</CopyPrompt>
|
|
17
|
+
|
|
18
|
+
## What it does
|
|
19
|
+
|
|
20
|
+
The provider handles these behaviors:
|
|
21
|
+
|
|
22
|
+
1. **Toast notifications**: Provides a global notification system for user feedback.
|
|
23
|
+
2. **Analytics**: Integrates Vercel Analytics and Speed Insights when the local adapter includes them.
|
|
24
|
+
3. **Search**: Configures the search dialog and connects it to your search API.
|
|
25
|
+
4. **Ask AI**: Provides the client state used by the chat sidebar and page actions.
|
|
26
|
+
|
|
27
|
+
## Usage
|
|
28
|
+
|
|
29
|
+
Ensure your application is wrapped with the provider in your root layout:
|
|
30
|
+
|
|
31
|
+
```tsx title="app/layout.tsx"
|
|
32
|
+
import { GeistdocsProvider } from "@/components/geistdocs/provider";
|
|
33
|
+
|
|
34
|
+
const Layout = ({ children }: LayoutProps) => (
|
|
35
|
+
<html lang="en">
|
|
36
|
+
<body>
|
|
37
|
+
<GeistdocsProvider>
|
|
38
|
+
<Navbar />
|
|
39
|
+
{children}
|
|
40
|
+
</GeistdocsProvider>
|
|
41
|
+
</body>
|
|
42
|
+
</html>
|
|
43
|
+
);
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
The generated local adapter imports the package provider and passes your site config to it.
|
|
47
|
+
|
|
48
|
+
## AI Sidebar
|
|
49
|
+
|
|
50
|
+
When users open the AI chat on desktop, the provider automatically adds padding to prevent content from being hidden behind the sidebar. On mobile, the chat opens as a drawer instead, so no padding is needed.
|
|
51
|
+
|
|
52
|
+
The provider detects the screen size and chat state.
|
|
53
|
+
|
|
54
|
+
## Toast Notifications
|
|
55
|
+
|
|
56
|
+
The provider includes a global toast notification system. Use it anywhere in your app:
|
|
57
|
+
|
|
58
|
+
```tsx title="page.tsx"
|
|
59
|
+
import { toast } from "sonner";
|
|
60
|
+
|
|
61
|
+
toast.success("Changes saved");
|
|
62
|
+
toast.error("Something went wrong");
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## Analytics
|
|
66
|
+
|
|
67
|
+
Vercel Analytics is automatically included and tracks:
|
|
68
|
+
|
|
69
|
+
- Page views
|
|
70
|
+
- Web Vitals
|
|
71
|
+
- User interactions
|
|
72
|
+
- Performance metrics
|
|
73
|
+
|
|
74
|
+
No configuration needed - it works automatically when deployed on Vercel.
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Proxy 和 Markdown 路由
|
|
3
|
+
description: 在保留包内 Markdown 协商逻辑的同时添加自定义请求逻辑
|
|
4
|
+
type: reference
|
|
5
|
+
summary: 使用 createProxy 的 before 和 after hooks、markdownRoutes 和静态 Next.js matcher 配置代理。
|
|
6
|
+
prerequisites:
|
|
7
|
+
- /docs/configuration
|
|
8
|
+
related:
|
|
9
|
+
- /docs/md
|
|
10
|
+
- /docs/llms-txt
|
|
11
|
+
- /docs/versioned-docs
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
Geistdocs proxy 负责 Markdown 协商、AI agent 重写、请求追踪和 i18n fallback。使用 hooks 添加站点特有的请求逻辑,而不是复制包内实现。
|
|
15
|
+
|
|
16
|
+
## 基础 proxy
|
|
17
|
+
|
|
18
|
+
生成的项目使用 `createProxy` 和默认的 `/docs` Markdown 路由:
|
|
19
|
+
|
|
20
|
+
```ts title="proxy.ts"
|
|
21
|
+
import { createProxy } from "@vercel/geistdocs/proxy";
|
|
22
|
+
import { config as geistdocsConfig } from "@/lib/geistdocs/config";
|
|
23
|
+
import { trackMdRequest } from "@/lib/geistdocs/md-tracking";
|
|
24
|
+
|
|
25
|
+
const proxy = createProxy({
|
|
26
|
+
config: geistdocsConfig,
|
|
27
|
+
trackMarkdownRequest: trackMdRequest,
|
|
28
|
+
});
|
|
29
|
+
|
|
30
|
+
export const config = {
|
|
31
|
+
matcher: [
|
|
32
|
+
"/((?!api|_next/static|_next/image|favicon.ico|sitemap.xml|robots.txt).*)",
|
|
33
|
+
],
|
|
34
|
+
};
|
|
35
|
+
|
|
36
|
+
export default proxy;
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
`export const config` 必须保持为静态对象。Next.js 会在构建时读取 proxy matcher,不支持在该导出中调用 helper。
|
|
40
|
+
|
|
41
|
+
## 自定义请求逻辑
|
|
42
|
+
|
|
43
|
+
使用 `before` 在 Geistdocs Markdown 处理之前运行逻辑。返回 `Response` 会停止后续处理。
|
|
44
|
+
|
|
45
|
+
```ts title="proxy.ts"
|
|
46
|
+
import { createProxy } from "@vercel/geistdocs/proxy";
|
|
47
|
+
import { NextResponse } from "next/server";
|
|
48
|
+
import { config as geistdocsConfig } from "@/lib/geistdocs/config";
|
|
49
|
+
|
|
50
|
+
const proxy = createProxy({
|
|
51
|
+
config: geistdocsConfig,
|
|
52
|
+
before: async ({ request, defaultLanguage }) => {
|
|
53
|
+
if (request.nextUrl.pathname === "/") {
|
|
54
|
+
return NextResponse.rewrite(
|
|
55
|
+
new URL(`/${defaultLanguage}/home`, request.url)
|
|
56
|
+
);
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
return null;
|
|
60
|
+
},
|
|
61
|
+
});
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
使用 `after` 在 Markdown 处理之后、i18n fallback 之前运行逻辑。
|
|
65
|
+
|
|
66
|
+
## Markdown 路由映射
|
|
67
|
+
|
|
68
|
+
`markdownRoutes` 将公开页面 URL 映射到返回 Markdown 的 App Router handler。包仍然通过 route helpers 服务 `/llms.txt` 和单页 Markdown;proxy 使用这些映射处理 `.md`、`.mdx`、`Accept: text/markdown` 和 AI-agent 请求。
|
|
69
|
+
|
|
70
|
+
```ts title="proxy.ts"
|
|
71
|
+
const proxy = createProxy({
|
|
72
|
+
config: geistdocsConfig,
|
|
73
|
+
markdownRoutes: [
|
|
74
|
+
{ from: "/docs/*path", to: "/[lang]/llms.mdx/*path" },
|
|
75
|
+
{ from: "/cookbook/*path", to: "/[lang]/llms.mdx/cookbook/*path" },
|
|
76
|
+
{ from: "/v5/docs/*path", to: "/[lang]/v5/llms.mdx/*path" },
|
|
77
|
+
],
|
|
78
|
+
});
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
| Request | Rewritten destination |
|
|
82
|
+
| --- | --- |
|
|
83
|
+
| `/docs/getting-started.md` | `/en/llms.mdx/getting-started` |
|
|
84
|
+
| `/cookbook/install.mdx` | `/en/llms.mdx/cookbook/install` |
|
|
85
|
+
| `/v5/docs/intro` with `Accept: text/markdown` | `/en/v5/llms.mdx/intro` |
|
|
86
|
+
|
|
87
|
+
## Hook context
|
|
88
|
+
|
|
89
|
+
`before` 和 `after` 接收相同的 context:
|
|
90
|
+
|
|
91
|
+
| Property | Type | Description |
|
|
92
|
+
| --- | --- | --- |
|
|
93
|
+
| `request` | `NextRequest` | 传入请求。 |
|
|
94
|
+
| `context` | `NextFetchEvent` | Proxy event,包含 `waitUntil`。 |
|
|
95
|
+
| `defaultLanguage` | `string` | 配置的默认语言。 |
|
|
96
|
+
| `languages` | `string[]` | 所有配置的语言。 |
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Proxy and markdown routes
|
|
3
|
+
description: Add custom request logic while keeping Geistdocs markdown negotiation in the package
|
|
4
|
+
type: reference
|
|
5
|
+
summary: Configure createProxy with before and after hooks, markdown route mappings, and a static Next.js matcher.
|
|
6
|
+
prerequisites:
|
|
7
|
+
- /docs/configuration
|
|
8
|
+
related:
|
|
9
|
+
- /docs/md
|
|
10
|
+
- /docs/llms-txt
|
|
11
|
+
- /docs/versioned-docs
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
The Geistdocs proxy handles markdown negotiation, AI-agent rewrites, request tracking, and i18n fallback. Add site-specific request logic with hooks instead of copying the package proxy implementation.
|
|
15
|
+
|
|
16
|
+
<CopyPrompt text="Review this Geistdocs proxy.ts file. Check that export const config is static, custom logic is inside createProxy before or after hooks, and markdownRoutes cover every public docs route family.">
|
|
17
|
+
Review this Geistdocs `proxy.ts` file. Check that `export const config` is static, custom logic is inside `createProxy` `before` or `after` hooks, and `markdownRoutes` cover every public docs route family.
|
|
18
|
+
</CopyPrompt>
|
|
19
|
+
|
|
20
|
+
## Basic proxy
|
|
21
|
+
|
|
22
|
+
Generated projects use `createProxy` with the default `/docs` markdown route:
|
|
23
|
+
|
|
24
|
+
```ts title="proxy.ts"
|
|
25
|
+
import { createProxy } from "@vercel/geistdocs/proxy";
|
|
26
|
+
import { config as geistdocsConfig } from "@/lib/geistdocs/config";
|
|
27
|
+
import { trackMdRequest } from "@/lib/geistdocs/md-tracking";
|
|
28
|
+
|
|
29
|
+
const proxy = createProxy({
|
|
30
|
+
config: geistdocsConfig,
|
|
31
|
+
trackMarkdownRequest: trackMdRequest,
|
|
32
|
+
});
|
|
33
|
+
|
|
34
|
+
export const config = {
|
|
35
|
+
matcher: [
|
|
36
|
+
"/((?!api|_next/static|_next/image|favicon.ico|sitemap.xml|robots.txt).*)",
|
|
37
|
+
],
|
|
38
|
+
};
|
|
39
|
+
|
|
40
|
+
export default proxy;
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Keep `export const config` as a static object. Next.js reads proxy matchers at build time and does not support calling a helper for this export.
|
|
44
|
+
|
|
45
|
+
## Custom request logic
|
|
46
|
+
|
|
47
|
+
Use `before` for logic that should run before Geistdocs markdown handling. Return a `Response` to stop processing.
|
|
48
|
+
|
|
49
|
+
```ts title="proxy.ts"
|
|
50
|
+
import { createProxy } from "@vercel/geistdocs/proxy";
|
|
51
|
+
import { NextResponse } from "next/server";
|
|
52
|
+
import { config as geistdocsConfig } from "@/lib/geistdocs/config";
|
|
53
|
+
|
|
54
|
+
const proxy = createProxy({
|
|
55
|
+
config: geistdocsConfig,
|
|
56
|
+
before: async ({ request, defaultLanguage }) => {
|
|
57
|
+
if (request.nextUrl.pathname === "/") {
|
|
58
|
+
return NextResponse.rewrite(
|
|
59
|
+
new URL(`/${defaultLanguage}/home`, request.url)
|
|
60
|
+
);
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
return null;
|
|
64
|
+
},
|
|
65
|
+
});
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Use `after` for logic that should run after markdown handling but before the i18n fallback:
|
|
69
|
+
|
|
70
|
+
```ts title="proxy.ts"
|
|
71
|
+
const proxy = createProxy({
|
|
72
|
+
config: geistdocsConfig,
|
|
73
|
+
after: async ({ request }) => {
|
|
74
|
+
const session = await getSessionFromReq(request);
|
|
75
|
+
|
|
76
|
+
if (!session) {
|
|
77
|
+
return null;
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
return refreshSession(request, session);
|
|
81
|
+
},
|
|
82
|
+
});
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
## Markdown route mappings
|
|
86
|
+
|
|
87
|
+
`markdownRoutes` maps public page URLs to the App Router handlers that return Markdown. The package still serves `/llms.txt` and individual page Markdown through route helpers; the proxy uses these mappings for `.md`, `.mdx`, `Accept: text/markdown`, and AI-agent requests.
|
|
88
|
+
|
|
89
|
+
```ts title="proxy.ts"
|
|
90
|
+
const proxy = createProxy({
|
|
91
|
+
config: geistdocsConfig,
|
|
92
|
+
markdownRoutes: [
|
|
93
|
+
{ from: "/docs/*path", to: "/[lang]/llms.mdx/*path" },
|
|
94
|
+
{ from: "/cookbook/*path", to: "/[lang]/llms.mdx/cookbook/*path" },
|
|
95
|
+
{ from: "/v5/docs/*path", to: "/[lang]/v5/llms.mdx/*path" },
|
|
96
|
+
],
|
|
97
|
+
});
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
With these mappings:
|
|
101
|
+
|
|
102
|
+
| Request | Rewritten destination |
|
|
103
|
+
| --- | --- |
|
|
104
|
+
| `/docs/getting-started.md` | `/en/llms.mdx/getting-started` |
|
|
105
|
+
| `/cookbook/install.mdx` | `/en/llms.mdx/cookbook/install` |
|
|
106
|
+
| `/v5/docs/intro` with `Accept: text/markdown` | `/en/v5/llms.mdx/intro` |
|
|
107
|
+
|
|
108
|
+
Use `[lang]` in the destination when your markdown route is nested under `app/[lang]`. Use `*path` or `:path*` to insert the matched wildcard path.
|
|
109
|
+
|
|
110
|
+
## Hook context
|
|
111
|
+
|
|
112
|
+
Both `before` and `after` receive the same context:
|
|
113
|
+
|
|
114
|
+
| Property | Type | Description |
|
|
115
|
+
| --- | --- | --- |
|
|
116
|
+
| `request` | `NextRequest` | The incoming request. |
|
|
117
|
+
| `context` | `NextFetchEvent` | The proxy event, including `waitUntil`. |
|
|
118
|
+
| `defaultLanguage` | `string` | The configured default language. |
|
|
119
|
+
| `languages` | `string[]` | All configured languages. |
|
|
120
|
+
|
|
121
|
+
## Next steps
|
|
122
|
+
|
|
123
|
+
- Read [.md extension](/docs/md) to understand single-page Markdown responses.
|
|
124
|
+
- Read [Versioned docs](/docs/versioned-docs) to map multiple public route families.
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: RSS
|
|
3
|
+
description: 通过为您的文档自动生成的 RSS 订阅源让用户保持更新
|
|
4
|
+
type: conceptual
|
|
5
|
+
summary: 自动生成的 RSS 2.0 订阅源,在文档发布或更新时通知用户。
|
|
6
|
+
related:
|
|
7
|
+
- /docs/env
|
|
8
|
+
- /docs/configuration
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
RSS 功能为您的文档提供了一个自动生成的 RSS 2.0 订阅源。用户可以订阅该订阅源,在发布新内容或修改现有页面时及时收到通知。
|
|
12
|
+
|
|
13
|
+
## 工作原理
|
|
14
|
+
|
|
15
|
+
Geistdocs 会自动生成一个包含以下内容的 RSS 订阅源:
|
|
16
|
+
|
|
17
|
+
- 所有已发布的文档页面
|
|
18
|
+
- 页面标题和描述
|
|
19
|
+
- 每页的直接链接
|
|
20
|
+
- 最后修改日期
|
|
21
|
+
- 作者信息
|
|
22
|
+
|
|
23
|
+
订阅源会在每次请求时重新生成,确保订阅者始终收到有关文档的最新信息。
|
|
24
|
+
|
|
25
|
+
## 访问订阅源
|
|
26
|
+
|
|
27
|
+
RSS 订阅源可通过以下地址访问:
|
|
28
|
+
|
|
29
|
+
```
|
|
30
|
+
https://your-domain.com/rss.xml
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
用户可以使用以下方式订阅该 URL:
|
|
34
|
+
|
|
35
|
+
- RSS 阅读器 (Feedly, Inoreader, NewsBlur)
|
|
36
|
+
- 电子邮件服务 (Blogtrottr, Kill the Newsletter)
|
|
37
|
+
- 浏览器扩展
|
|
38
|
+
- 新闻聚合器
|
|
39
|
+
|
|
40
|
+
### RSS 按钮
|
|
41
|
+
|
|
42
|
+
导航栏中会显示一个便捷的 RSS 按钮,方便用户发现并订阅您的订阅源。单击该按钮会在新标签页中打开 RSS XML。
|
|
43
|
+
|
|
44
|
+
## 订阅源格式
|
|
45
|
+
|
|
46
|
+
该 RSS 订阅源遵循 RSS 2.0 规范,并包含以下内容:
|
|
47
|
+
|
|
48
|
+
### 频道元数据
|
|
49
|
+
|
|
50
|
+
```xml
|
|
51
|
+
<channel>
|
|
52
|
+
<title>Your Documentation Title</title>
|
|
53
|
+
<link>https://your-domain.com</link>
|
|
54
|
+
<language>en</language>
|
|
55
|
+
<image>https://your-domain.com/banner.png</image>
|
|
56
|
+
<copyright>All rights reserved [Year], [Your Organization]</copyright>
|
|
57
|
+
</channel>
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### 条目格式
|
|
61
|
+
|
|
62
|
+
每个文档页面都会作为一个条目出现:
|
|
63
|
+
|
|
64
|
+
```xml
|
|
65
|
+
<item>
|
|
66
|
+
<guid>page-url</guid>
|
|
67
|
+
<title>Page Title</title>
|
|
68
|
+
<description>Page description</description>
|
|
69
|
+
<link>https://your-domain.com/docs/page-url</link>
|
|
70
|
+
<pubDate>Thu, 12 Nov 2025 00:00:00 GMT</pubDate>
|
|
71
|
+
<author>
|
|
72
|
+
<name>Your Organization</name>
|
|
73
|
+
</author>
|
|
74
|
+
</item>
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
## 配置
|
|
78
|
+
|
|
79
|
+
RSS 订阅源要求设置 `NEXT_PUBLIC_VERCEL_PROJECT_PRODUCTION_URL` 环境变量,您可以在 [环境变量](/docs/env) 一节中阅读更多信息。
|
|
80
|
+
|
|
81
|
+
它还需要在 Geistdocs 配置文件中导出一个 `title`,您可以在 [配置](/docs/configuration) 一节中阅读更多信息。
|
|
82
|
+
|
|
83
|
+
## 功能
|
|
84
|
+
|
|
85
|
+
### 自动更新
|
|
86
|
+
|
|
87
|
+
订阅源会自动包含:
|
|
88
|
+
|
|
89
|
+
- 新创建的页面
|
|
90
|
+
- 已更新的页面内容(使用最后修改日期)
|
|
91
|
+
- 更改的标题或描述
|
|
92
|
+
- 来自您的文档源的所有页面
|
|
93
|
+
|
|
94
|
+
### 最后修改日期
|
|
95
|
+
|
|
96
|
+
页面使用它们的 `lastModified` frontmatter 字段,或回退到当前日期:
|
|
97
|
+
|
|
98
|
+
```mdx title="content/docs/example.mdx"
|
|
99
|
+
---
|
|
100
|
+
title: Example Page
|
|
101
|
+
description: An example documentation page
|
|
102
|
+
lastModified: 2025-11-12
|
|
103
|
+
---
|
|
104
|
+
```
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: RSS
|
|
3
|
+
description: Keep users updated with an automatically generated RSS feed for your documentation
|
|
4
|
+
type: conceptual
|
|
5
|
+
summary: An automatically generated RSS 2.0 feed that keeps users informed when documentation is published or updated.
|
|
6
|
+
related:
|
|
7
|
+
- /docs/env
|
|
8
|
+
- /docs/configuration
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
The RSS feature provides an automatically generated RSS 2.0 feed for your documentation. This allows users to subscribe to updates and stay informed when new content is published or existing pages are modified.
|
|
12
|
+
|
|
13
|
+
<CopyPrompt text="Help me verify the RSS feed for this Geistdocs site. Check the /rss.xml route, confirm the production URL environment variable is set, and explain how page metadata affects feed items.">
|
|
14
|
+
Help me verify the RSS feed for this Geistdocs site. Check the `/rss.xml` route, confirm the production URL environment variable is set, and explain how page metadata affects feed items.
|
|
15
|
+
</CopyPrompt>
|
|
16
|
+
|
|
17
|
+
## How it works
|
|
18
|
+
|
|
19
|
+
Geistdocs automatically generates an RSS feed that includes:
|
|
20
|
+
|
|
21
|
+
- All published documentation pages
|
|
22
|
+
- Page titles and descriptions
|
|
23
|
+
- Direct links to each page
|
|
24
|
+
- Last modified dates
|
|
25
|
+
- Author information
|
|
26
|
+
|
|
27
|
+
The feed is regenerated on each request, ensuring subscribers always receive the most current information about your documentation.
|
|
28
|
+
|
|
29
|
+
## Accessing the Feed
|
|
30
|
+
|
|
31
|
+
The RSS feed is available at:
|
|
32
|
+
|
|
33
|
+
```
|
|
34
|
+
https://your-domain.com/rss.xml
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Users can subscribe to this URL using:
|
|
38
|
+
|
|
39
|
+
- RSS readers (Feedly, Inoreader, NewsBlur)
|
|
40
|
+
- Email services (Blogtrottr, Kill the Newsletter)
|
|
41
|
+
- Browser extensions
|
|
42
|
+
- News aggregators
|
|
43
|
+
|
|
44
|
+
### RSS Button
|
|
45
|
+
|
|
46
|
+
An RSS button appears in the navigation bar so readers can discover and subscribe to your feed. Clicking the button opens the RSS XML in a new tab.
|
|
47
|
+
|
|
48
|
+
## Feed Format
|
|
49
|
+
|
|
50
|
+
The RSS feed follows the RSS 2.0 specification and includes:
|
|
51
|
+
|
|
52
|
+
### Channel Metadata
|
|
53
|
+
|
|
54
|
+
```xml
|
|
55
|
+
<channel>
|
|
56
|
+
<title>Your Documentation Title</title>
|
|
57
|
+
<link>https://your-domain.com</link>
|
|
58
|
+
<language>en</language>
|
|
59
|
+
<image>https://your-domain.com/banner.png</image>
|
|
60
|
+
<copyright>All rights reserved [Year], [Your Organization]</copyright>
|
|
61
|
+
</channel>
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Item Format
|
|
65
|
+
|
|
66
|
+
Each documentation page appears as an item:
|
|
67
|
+
|
|
68
|
+
```xml
|
|
69
|
+
<item>
|
|
70
|
+
<guid>page-url</guid>
|
|
71
|
+
<title>Page Title</title>
|
|
72
|
+
<description>Page description</description>
|
|
73
|
+
<link>https://your-domain.com/docs/page-url</link>
|
|
74
|
+
<pubDate>Thu, 12 Nov 2025 00:00:00 GMT</pubDate>
|
|
75
|
+
<author>
|
|
76
|
+
<name>Your Organization</name>
|
|
77
|
+
</author>
|
|
78
|
+
</item>
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
## Configuration
|
|
82
|
+
|
|
83
|
+
The RSS feed requires the `NEXT_PUBLIC_VERCEL_PROJECT_PRODUCTION_URL` environment variable to be set, which you can read more about in the [Environment Variables](/docs/env) section.
|
|
84
|
+
|
|
85
|
+
It also requires a `title` exported from the Geistdocs configuration file, which you can read more about in the [Configuration](/docs/configuration) section.
|
|
86
|
+
|
|
87
|
+
## Features
|
|
88
|
+
|
|
89
|
+
### Automatic Updates
|
|
90
|
+
|
|
91
|
+
The feed automatically includes:
|
|
92
|
+
|
|
93
|
+
- Newly created pages
|
|
94
|
+
- Updated page content (using last modified dates)
|
|
95
|
+
- Changed titles or descriptions
|
|
96
|
+
- All pages from your documentation source
|
|
97
|
+
|
|
98
|
+
### Last Modified Dates
|
|
99
|
+
|
|
100
|
+
Pages use their `lastModified` frontmatter field or fall back to the current date:
|
|
101
|
+
|
|
102
|
+
```mdx title="content/docs/example.mdx"
|
|
103
|
+
---
|
|
104
|
+
title: Example Page
|
|
105
|
+
description: An example documentation page
|
|
106
|
+
lastModified: 2025-11-12
|
|
107
|
+
---
|
|
108
|
+
```
|