@vercel/geistdocs 2.14.5 → 2.14.7
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-share.d.ts +13 -0
- package/dist/assets/icons/icon-share.d.ts.map +1 -0
- package/dist/assets/icons/icon-share.js +12 -0
- package/dist/assets/icons/index.d.ts +1 -0
- package/dist/assets/icons/index.d.ts.map +1 -1
- package/dist/assets/icons/index.js +1 -0
- package/dist/cli/index.js +1 -1
- package/dist/config.d.ts +15 -0
- package/dist/config.d.ts.map +1 -1
- package/dist/controls.d.ts +3 -40
- package/dist/controls.d.ts.map +1 -1
- package/dist/controls.js +5 -96
- package/dist/internal/chat/share-chat.d.ts +7 -0
- package/dist/internal/chat/share-chat.d.ts.map +1 -0
- package/dist/internal/chat/share-chat.js +76 -0
- package/dist/internal/chat/sharing.d.ts +24 -0
- package/dist/internal/chat/sharing.d.ts.map +1 -0
- package/dist/internal/chat/sharing.js +117 -0
- package/dist/internal/chat/shell.d.ts.map +1 -1
- package/dist/internal/chat/shell.js +2 -1
- package/dist/internal/controls-client.d.ts +40 -0
- package/dist/internal/controls-client.d.ts.map +1 -0
- package/dist/internal/controls-client.js +87 -0
- package/dist/internal/language-selector.d.ts +2 -0
- package/dist/internal/language-selector.d.ts.map +1 -0
- package/dist/internal/language-selector.js +12 -0
- package/dist/internal/navbar/mobile-menu.js +1 -1
- package/dist/internal/page-action-options.d.ts +37 -0
- package/dist/internal/page-action-options.d.ts.map +1 -0
- package/dist/internal/page-action-options.js +39 -0
- package/dist/internal/page-actions-client.d.ts +1 -31
- package/dist/internal/page-actions-client.d.ts.map +1 -1
- package/dist/internal/page-actions-client.js +5 -103
- package/dist/internal/page-actions-gate.d.ts +3 -0
- package/dist/internal/page-actions-gate.d.ts.map +1 -0
- package/dist/internal/page-actions-gate.js +15 -0
- package/dist/internal/provider-client.d.ts.map +1 -1
- package/dist/internal/provider-client.js +26 -1
- package/dist/internal/relative-docs-link.d.ts +7 -0
- package/dist/internal/relative-docs-link.d.ts.map +1 -0
- package/dist/internal/relative-docs-link.js +22 -0
- package/dist/internal/sidebar.d.ts.map +1 -1
- package/dist/internal/sidebar.js +1 -1
- package/dist/internal/toc-actions-client.d.ts +9 -0
- package/dist/internal/toc-actions-client.d.ts.map +1 -0
- package/dist/internal/toc-actions-client.js +78 -0
- package/dist/mdx.d.ts.map +1 -1
- package/dist/mdx.js +5 -2
- package/dist/navbar.js +1 -1
- package/dist/pages/changelog.js +1 -1
- package/dist/pages/docs.d.ts.map +1 -1
- package/dist/pages/docs.js +4 -3
- package/docs/agents.md +1 -1
- package/docs/llms.txt +27 -1
- package/docs/manifest.json +1 -1
- package/docs/pages/ask-ai.md +16 -0
- package/docs/pages/configuration.md +7 -0
- package/docs/pages/provider.md +3 -0
- package/package.json +1 -1
- package/template/content/docs/ask-ai.mdx +16 -0
- package/template/content/docs/configuration.mdx +7 -0
- package/template/content/docs/provider.mdx +3 -0
- package/template/package.json +1 -1
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
"use client";
|
|
2
|
+
import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
|
|
3
|
+
import { usePathname } from "next/navigation";
|
|
4
|
+
import { useEffect, useState, useTransition, } from "react";
|
|
5
|
+
import { IconAcronymMarkdown, IconArrowCircleUp, IconThumbUp, } from "#geistdocs-assets/icons";
|
|
6
|
+
import { Button } from "#geistdocs-ui/components/button";
|
|
7
|
+
import { Textarea } from "#geistdocs-ui/components/textarea";
|
|
8
|
+
import { sendFeedback } from "./feedback-action";
|
|
9
|
+
import { Popover, PopoverContent, PopoverTrigger } from "./ui/popover";
|
|
10
|
+
import { useIsMobile } from "./use-mobile";
|
|
11
|
+
const actionClassName = "group flex min-h-8 w-full min-w-0 touch-manipulation items-center gap-2 rounded-md text-left text-gray-900 text-label-14 transition-colors hover:text-gray-1000 focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-blue-700 focus-visible:ring-offset-2 focus-visible:ring-offset-background-100 motion-reduce:transition-none [&_svg]:size-4 [&_svg]:shrink-0 [&_span]:min-w-0 [&_span]:truncate";
|
|
12
|
+
const feedbackEmotions = [
|
|
13
|
+
{ name: "cry", emoji: "😭" },
|
|
14
|
+
{ name: "sad", emoji: "😕" },
|
|
15
|
+
{ name: "happy", emoji: "🙂" },
|
|
16
|
+
{ name: "amazed", emoji: "🤩" },
|
|
17
|
+
];
|
|
18
|
+
const ScrollTopAction = () => (_jsxs("button", { className: actionClassName, onClick: () => {
|
|
19
|
+
const reduceMotion = window.matchMedia("(prefers-reduced-motion: reduce)").matches;
|
|
20
|
+
window.scrollTo({ top: 0, behavior: reduceMotion ? "auto" : "smooth" });
|
|
21
|
+
}, type: "button", children: [_jsx(IconArrowCircleUp, { className: "size-3.5" }), _jsx("span", { children: "Scroll to top" })] }));
|
|
22
|
+
const FeedbackAction = ({ siteId }) => {
|
|
23
|
+
const isMobile = useIsMobile();
|
|
24
|
+
const url = usePathname();
|
|
25
|
+
const [submitted, setSubmitted] = useState(false);
|
|
26
|
+
const [emotion, setEmotion] = useState(null);
|
|
27
|
+
const [message, setMessage] = useState("");
|
|
28
|
+
const [failed, setFailed] = useState(false);
|
|
29
|
+
const [isPending, startTransition] = useTransition();
|
|
30
|
+
useEffect(() => {
|
|
31
|
+
const item = localStorage.getItem(`docs-feedback-${url}`);
|
|
32
|
+
if (!item) {
|
|
33
|
+
return;
|
|
34
|
+
}
|
|
35
|
+
setSubmitted(true);
|
|
36
|
+
}, [url]);
|
|
37
|
+
const submit = (event) => {
|
|
38
|
+
event.preventDefault();
|
|
39
|
+
if (!emotion) {
|
|
40
|
+
return;
|
|
41
|
+
}
|
|
42
|
+
startTransition(async () => {
|
|
43
|
+
const feedback = {
|
|
44
|
+
emotion,
|
|
45
|
+
message,
|
|
46
|
+
};
|
|
47
|
+
const result = await sendFeedback({ url, feedback, siteId });
|
|
48
|
+
// Keep the form (and the visitor's text) so a failed submission can
|
|
49
|
+
// be retried.
|
|
50
|
+
if (!result.success) {
|
|
51
|
+
setFailed(true);
|
|
52
|
+
return;
|
|
53
|
+
}
|
|
54
|
+
setFailed(false);
|
|
55
|
+
setSubmitted(true);
|
|
56
|
+
localStorage.setItem(`docs-feedback-${url}`, "1");
|
|
57
|
+
setMessage("");
|
|
58
|
+
setEmotion(null);
|
|
59
|
+
});
|
|
60
|
+
};
|
|
61
|
+
return (_jsxs(Popover, { children: [_jsx(PopoverTrigger, { asChild: true, children: _jsxs("button", { className: actionClassName, type: "button", children: [_jsx(IconThumbUp, { className: "size-3.5" }), _jsx("span", { children: "Give feedback" })] }) }), _jsx(PopoverContent, { className: "overflow-hidden p-0", children: _jsx("div", { className: "overflow-visible", children: submitted ? (_jsx("div", { className: "flex flex-col items-center gap-3 rounded-xl bg-background-200 px-3 py-6 text-center text-copy-14", role: "status", children: _jsx("p", { children: "Thank you for your feedback!" }) })) : (_jsxs("form", { className: "flex flex-col", onSubmit: submit, children: [_jsx("div", { className: "p-2", children: _jsx(Textarea, { "aria-label": "Feedback", autoComplete: "off", autoFocus: !isMobile, className: "max-h-48 min-h-24 shadow-none", name: "feedback", onChange: (event) => setMessage(event.target.value), onKeyDown: (event) => {
|
|
62
|
+
if (!event.shiftKey && event.key === "Enter") {
|
|
63
|
+
event.currentTarget.form?.requestSubmit();
|
|
64
|
+
}
|
|
65
|
+
}, placeholder: "Leave your feedback\u2026", required: true, value: message }) }), _jsxs("div", { className: "flex items-center justify-end gap-1 px-2 text-gray-900", children: [_jsx(IconAcronymMarkdown, { "aria-hidden": "true", className: "inline size-3" }), _jsx("p", { className: "text-label-12", children: " supported" })] }), failed ? (_jsx("p", { className: "px-2 pb-1 text-label-12 text-red-900", role: "alert", children: "Sending feedback failed. Please try again." })) : null, _jsxs("div", { className: "mt-2 flex items-center justify-between border-t bg-background-200 p-2", children: [_jsx("div", { className: "flex items-center gap-px", children: feedbackEmotions.map((entry) => (_jsxs(Button, { className: emotion === entry.name
|
|
66
|
+
? "bg-gray-100 text-gray-1000"
|
|
67
|
+
: "text-gray-900 hover:text-gray-1000", onClick: () => setEmotion(entry.name), size: "small", type: "unstyled", typeName: "button", children: [entry.emoji, _jsx("span", { className: "sr-only", children: entry.name })] }, entry.name))) }), _jsx(Button, { disabled: isPending || !emotion || !message, size: "small", typeName: "submit", children: "Send" })] })] })) }) })] }));
|
|
68
|
+
};
|
|
69
|
+
export const GeistdocsTableOfContentsActions = ({ config, extraActions, }) => {
|
|
70
|
+
const actions = [];
|
|
71
|
+
if (config.pageActions?.scrollTop !== false) {
|
|
72
|
+
actions.push(_jsx(ScrollTopAction, {}, "scroll-top"));
|
|
73
|
+
}
|
|
74
|
+
if (config.feedback?.enabled !== false) {
|
|
75
|
+
actions.push(_jsx(FeedbackAction, { siteId: config.siteId }, "feedback"));
|
|
76
|
+
}
|
|
77
|
+
return (_jsxs(_Fragment, { children: [actions, extraActions] }));
|
|
78
|
+
};
|
package/dist/mdx.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"mdx.d.ts","sourceRoot":"","sources":["../src/mdx.tsx"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"mdx.d.ts","sourceRoot":"","sources":["../src/mdx.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAiC/C,OAAO,KAAK,EAAE,4BAA4B,IAAI,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAK3F,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;CAAa,CAAC;AAC1C,MAAM,MAAM,4BAA4B,GAAG,mBAAmB,CAAC;AAE/D,MAAM,MAAM,sBAAsB,GAAG,aAAa,CAAC;AAEnD,eAAO,MAAM,yBAAyB,GACpC,aAAa,sBAAsB,KAClC,sBAsED,CAAC;AAEH,eAAO,MAAM,mBAAmB,GAC9B,aAAa,sBAAsB,KAClC,sBAA+D,CAAC;AAEnE,eAAO,MAAM,2BAA2B,GACtC,GAAG,eAAe,KAAK,CAAC,sBAAsB,GAAG,SAAS,CAAC,KAC1D,sBACkD,CAAC"}
|
package/dist/mdx.js
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { jsx as _jsx } from "react/jsx-runtime";
|
|
2
|
-
import
|
|
2
|
+
import { Image as FrameworkImage } from "fumadocs-core/framework";
|
|
3
|
+
import { Card, Cards } from "fumadocs-ui/components/card";
|
|
3
4
|
import Link from "next/link";
|
|
4
5
|
import { cn } from "#geistdocs-ui/utils";
|
|
5
6
|
import { Blockquote } from "./components/blockquote";
|
|
@@ -21,7 +22,9 @@ import { geistShikiTheme as shikiTheme } from "./shiki-theme";
|
|
|
21
22
|
// language grammar, into every server function that renders MDX.
|
|
22
23
|
export const geistShikiTheme = shikiTheme;
|
|
23
24
|
export const getGeistdocsMDXComponents = (components) => ({
|
|
24
|
-
|
|
25
|
+
Card,
|
|
26
|
+
Cards,
|
|
27
|
+
img: (props) => (_jsx(FrameworkImage, { sizes: "(max-width: 768px) 100vw, (max-width: 1200px) 70vw, 900px", ...props, className: cn("rounded-lg", props.className), src: props.src })),
|
|
25
28
|
h1: (props) => _jsx(Heading, { as: "h1", ...props }),
|
|
26
29
|
h2: (props) => _jsx(Heading, { as: "h2", ...props }),
|
|
27
30
|
h3: (props) => _jsx(Heading, { as: "h3", ...props }),
|
package/dist/navbar.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
|
|
2
|
-
import { AskAIButton, SearchButton } from "./controls";
|
|
2
|
+
import { AskAIButton, SearchButton } from "./internal/controls-client";
|
|
3
3
|
import { GitHubButton, getGithubRepoUrl } from "./internal/github-button";
|
|
4
4
|
import { DesktopMenu } from "./internal/navbar/desktop-menu";
|
|
5
5
|
import { MobileMenu } from "./internal/navbar/mobile-menu";
|
package/dist/pages/changelog.js
CHANGED
|
@@ -3,7 +3,7 @@ import { notFound, redirect } from "next/navigation";
|
|
|
3
3
|
import { getChangelogPage, getChangelogPageParams, getChangelogPagePath, getChangelogPath, parseChangelogPage, } from "../internal/changelog";
|
|
4
4
|
import { ChangelogFeed } from "../internal/changelog-feed";
|
|
5
5
|
import { getGeistdocsLanguageConfig, getLanguageStaticParams, omitLanguageParam, resolveRouteLanguage, } from "../internal/languages";
|
|
6
|
-
import { GeistdocsPageActions } from "../internal/page-actions-
|
|
6
|
+
import { GeistdocsPageActions } from "../internal/page-actions-gate";
|
|
7
7
|
const TRAILING_SLASH_PATTERN = /\/$/;
|
|
8
8
|
export const createChangelogPage = (options) => {
|
|
9
9
|
const { config, source, path = "/changelog", title = "Changelog", description = "The latest releases, improvements, and fixes.", getLang, markdownPath, dataPath, pageSize = 10, } = options;
|
package/dist/pages/docs.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"docs.d.ts","sourceRoot":"","sources":["../../src/pages/docs.tsx"],"names":[],"mappings":"AACA,OAAO,EAEL,QAAQ,IAAI,gBAAgB,EAE7B,MAAM,+BAA+B,CAAC;
|
|
1
|
+
{"version":3,"file":"docs.d.ts","sourceRoot":"","sources":["../../src/pages/docs.tsx"],"names":[],"mappings":"AACA,OAAO,EAEL,QAAQ,IAAI,gBAAgB,EAE7B,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAErC,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,aAAa,EAElB,KAAK,SAAS,EACf,MAAM,OAAO,CAAC;AAEf,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,KAAK,eAAe,EAA+B,MAAM,WAAW,CAAC;AAgB9E,OAAO,EACL,KAAK,2BAA2B,EAEjC,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAEvD,KAAK,YAAY,GAAG,qBAAqB,CAAC;AAC1C,KAAK,aAAa,GAAG,WAAW,CAAC,UAAU,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;AAChF,KAAK,iBAAiB,GAAG,UAAU,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAC9D,KAAK,YAAY,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;AACvC,KAAK,qBAAqB,GAAG,WAAW,CACtC,cAAc,CAAC,OAAO,gBAAgB,CAAC,CAAC,gBAAgB,CAAC,CAC1D,CAAC;AACF,MAAM,WAAW,cACf,SAAQ,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC;IACrD,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,qBAAqB,CACpC,MAAM,SAAS,cAAc,GAAG,cAAc;IAE9C,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,YAAY,CAAC;CACtB;AAED,MAAM,MAAM,oBAAoB,CAC9B,MAAM,SAAS,cAAc,GAAG,cAAc,IAC5C,CACF,IAAI,EAAE,aAAa,EACnB,OAAO,EAAE,qBAAqB,CAAC,MAAM,CAAC,KACnC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;AAEhC,KAAK,WAAW,GACZ,aAAa,GACb,CAAC,CAAC,OAAO,EAAE;IACT,IAAI,EAAE,YAAY,CAAC;IACnB,IAAI,EAAE,aAAa,CAAC;IACpB,MAAM,EAAE,YAAY,CAAC;CACtB,KAAK,aAAa,CAAC,CAAC;AAEzB,KAAK,eAAe,GAAG,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;AAEpE,UAAU,wBAAwB;IAChC,MAAM,CAAC,EAAE,OAAO,GAAG,eAAe,CAAC;CACpC;AA4BD,UAAU,cAAc,CAAC,MAAM,SAAS,cAAc,GAAG,cAAc;IACrE,IAAI,EAAE,aAAa,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,UAAU,oBAAoB,CAAC,MAAM,SAAS,cAAc,GAAG,cAAc,CAC3E,SAAQ,cAAc,CAAC,MAAM,CAAC;IAC9B,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,UAAU,kBAAkB,CAAC,MAAM,SAAS,cAAc,GAAG,cAAc,CACzE,SAAQ,oBAAoB,CAAC,MAAM,CAAC;IACpC,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,6BAA6B;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,eAAO,MAAM,sBAAsB,GACjC,SAAS,6BAA6B,WACI,CAAC;AAE7C,UAAU,YAAa,SAAQ,2BAA2B;IACxD,IAAI,EAAE,aAAa,CAAC;QAAE,UAAU,CAAC,EAAE,aAAa,CAAA;KAAE,CAAC,CAAC;IACpD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,cAAc,CAAC,OAAO,gBAAgB,CAAC,CAAC,KAAK,CAAC,CAAC;CACrD;AAED,MAAM,WAAW,qBAAqB,CACpC,MAAM,SAAS,cAAc,GAAG,cAAc;IAE9C,4EAA4E;IAC5E,WAAW,CAAC,EAAE,oBAAoB,CAAC,MAAM,CAAC,CAAC;IAC3C,MAAM,EAAE,IAAI,CACV,eAAe,EACb,IAAI,GACJ,UAAU,GACV,iBAAiB,GACjB,UAAU,GACV,QAAQ,GACR,aAAa,GACb,QAAQ,GACR,gBAAgB,GAChB,SAAS,CACZ,CAAC;IACF,kBAAkB,CAAC,EAAE,CAAC,MAAM,EAAE,cAAc,KAAK,OAAO,CAAC;IACzD,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,kBAAkB,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC;IACjE,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,cAAc,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC;IACzD,gBAAgB,CAAC,EAAE,CAAC,OAAO,EAAE,oBAAoB,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC;IACrE,GAAG,CAAC,EAAE,WAAW,CAAC;IAClB,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE;QACnB,QAAQ,EAAE,QAAQ,CAAC;QACnB,IAAI,EAAE,aAAa,CAAC;QACpB,MAAM,EAAE,MAAM,CAAC;KAChB,KAAK,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IACnC,SAAS,CAAC,EAAE,wBAAwB,CAAC;IACrC,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAChC,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE;QACpB,IAAI,EAAE,YAAY,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;QACpB,IAAI,EAAE,aAAa,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC;QAChB,aAAa,EAAE,MAAM,CAAC;KACvB,KAAK,SAAS,CAAC;IAChB,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE;QACtB,IAAI,EAAE,YAAY,CAAC;QACnB,UAAU,EAAE,OAAO,cAAc,CAAC;QAClC,IAAI,EAAE,aAAa,CAAC;QACpB,MAAM,EAAE,YAAY,CAAC;KACtB,KAAK,YAAY,CAAC;IACnB,MAAM,EAAE,YAAY,CAAC;IACrB,cAAc,CAAC,EAAE,qBAAqB,CAAC;IACvC,qBAAqB,CAAC,EAAE,cAAc,CACpC,OAAO,gBAAgB,CACxB,CAAC,uBAAuB,CAAC,CAAC;CAC5B;AAmDD,eAAO,MAAM,cAAc,GAAI,MAAM,SAAS,cAAc,GAAG,cAAc,EAAE,0MAgB5E,qBAAqB,CAAC,MAAM,CAAC;uBAgPJ;QAAE,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;KAAE;0BAvKlB,MAAM;;;;oCAwLtC;QACD,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;KACzB,KAAG,OAAO,CAAC,QAAQ,CAAC;CAqDtB,CAAC;AAEF,eAAO,MAAM,iBAAiB;;;CAA4B,CAAC"}
|
package/dist/pages/docs.js
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
|
|
2
2
|
import Link from "fumadocs-core/link";
|
|
3
3
|
import { DocsBody as FumadocsDocsBody, DocsPage as FumadocsDocsPage, DocsTitle as FumadocsDocsTitle, } from "fumadocs-ui/layouts/docs/page";
|
|
4
|
-
import { createRelativeLink } from "fumadocs-ui/mdx";
|
|
5
4
|
import { notFound } from "next/navigation";
|
|
6
5
|
import { cache, } from "react";
|
|
7
6
|
import { cn } from "#geistdocs-ui/utils";
|
|
@@ -14,11 +13,13 @@ import { omitLanguageParam, resolveRouteLanguage } from "../internal/languages";
|
|
|
14
13
|
import { resolveLinkHref, stripBasePathFromHref } from "../internal/link-href";
|
|
15
14
|
import { resolvePageMarkdownUrl as resolveInternalPageMarkdownUrl } from "../internal/markdown-url.js";
|
|
16
15
|
import { createPageActions as createInternalPageActions } from "../internal/page-actions";
|
|
17
|
-
import { GeistdocsPageActions
|
|
16
|
+
import { GeistdocsPageActions } from "../internal/page-actions-gate";
|
|
18
17
|
import { PageBreadcrumb } from "../internal/page-breadcrumb";
|
|
19
18
|
import { getPageFooterItems, PageFooter } from "../internal/page-footer";
|
|
20
19
|
import { filterPageTree } from "../internal/page-tree-visibility";
|
|
20
|
+
import { createRelativeDocsLink } from "../internal/relative-docs-link";
|
|
21
21
|
import { GeistdocsTableOfContents } from "../internal/table-of-contents";
|
|
22
|
+
import { GeistdocsTableOfContentsActions } from "../internal/toc-actions-client";
|
|
22
23
|
import { createMdxComponents } from "../mdx";
|
|
23
24
|
import { getPageRobots, } from "../page-visibility";
|
|
24
25
|
const renderPrefetchedDocsLink = (siteUrl, basePath, { children, className, href, rel, target, ...props }) => {
|
|
@@ -106,7 +107,7 @@ export const createDocsPage = ({ canViewPage, config, source, mdx, pageActions =
|
|
|
106
107
|
const pageTree = await getPageTree(resolvedParams);
|
|
107
108
|
const data = page.data;
|
|
108
109
|
const MDX = data.body;
|
|
109
|
-
const defaultLink =
|
|
110
|
+
const defaultLink = createRelativeDocsLink(source.source, page, DocsLink);
|
|
110
111
|
const link = resolveLink
|
|
111
112
|
? resolveLink({
|
|
112
113
|
link: defaultLink,
|
package/docs/agents.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Geistdocs Package Docs
|
|
2
2
|
|
|
3
|
-
These docs are bundled with `@vercel/geistdocs` 2.14.
|
|
3
|
+
These docs are bundled with `@vercel/geistdocs` 2.14.7 so agents can understand the installed package without web access.
|
|
4
4
|
They are generated from `apps/template/content/docs` during the package build.
|
|
5
5
|
|
|
6
6
|
## How to use these files
|
package/docs/llms.txt
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Geistdocs Package Documentation
|
|
2
2
|
|
|
3
|
-
These docs are bundled with `@vercel/geistdocs` 2.14.
|
|
3
|
+
These docs are bundled with `@vercel/geistdocs` 2.14.7.
|
|
4
4
|
They describe how to build package-backed Geistdocs sites and how to use the package APIs from generated project adapters.
|
|
5
5
|
|
|
6
6
|
## Documentation Index
|
|
@@ -1370,6 +1370,7 @@ The `ai` config also controls the chat panel and its route:
|
|
|
1370
1370
|
| `suggestions` | `(string \| { text: string; icon?: ReactNode })[]` | `[]` | Suggested prompts. The first four distinct prompts are shown, and strings render without an icon. |
|
|
1371
1371
|
| `history.retentionDays` | `number` | `30` | Days a stored conversation is kept after its most recent message. `0` stores no history, and `Infinity` never expires it. |
|
|
1372
1372
|
| `messageFeedback` | `boolean` | `false` | Show thumbs up and thumbs down buttons on finished answers and send votes to the Geistdocs feedback service. |
|
|
1373
|
+
| `share` | `GeistdocsAIShareConfig` | `undefined` | Show a Share chat action backed by your persistence endpoint and public shared-conversation route. |
|
|
1373
1374
|
| `toolLabels` | `Record<string, string>` | `{}` | Activity label shown while a named tool runs, such as `{ web_search: "Searching..." }`. Other tools show `Running <tool name>...`. |
|
|
1374
1375
|
|
|
1375
1376
|
```tsx title="geistdocs.tsx"
|
|
@@ -1378,9 +1379,15 @@ export const ai = {
|
|
|
1378
1379
|
title: "Ask Acme AI",
|
|
1379
1380
|
history: { retentionDays: 7 },
|
|
1380
1381
|
messageFeedback: true,
|
|
1382
|
+
share: {
|
|
1383
|
+
endpoint: "/api/ai-chat/share",
|
|
1384
|
+
path: "/ai-chat",
|
|
1385
|
+
},
|
|
1381
1386
|
};
|
|
1382
1387
|
```
|
|
1383
1388
|
|
|
1389
|
+
The endpoint receives `{ messages, hostPath, summary? }` and must return `{ shareId }`. The public route at `path/<shareId>` must display the saved conversation. Both paths are app-local; Geistdocs adds `basePath` automatically. See [Share a conversation](/docs/ask-ai#share-a-conversation) for the full contract.
|
|
1390
|
+
|
|
1384
1391
|
See [Ask AI](/docs/ask-ai) for the full eve agent mode behavior, including authentication, for moving the chat route adapter when you set `endpoint`, for what a `messageFeedback` vote sends, and for matching a production Vertex or eve setup with `toolLabels` and the server-only `createChatRoute` options. Read [Improve Ask AI answers with Mixedbread](/docs/mixedbread-retrieval) before enabling semantic retrieval.
|
|
1385
1392
|
|
|
1386
1393
|
Use [Versioned docs](/docs/versioned-docs) for versioned source setup and [Proxy and markdown routes](/docs/proxy) for route mappings.
|
|
@@ -2502,6 +2509,9 @@ The provider handles these behaviors:
|
|
|
2502
2509
|
2. **Analytics**: Integrates Vercel Analytics and Speed Insights when the local adapter includes them.
|
|
2503
2510
|
3. **Search**: Configures the search dialog and connects it to your search API.
|
|
2504
2511
|
4. **Ask AI**: Provides the client state used by the chat sidebar and page actions.
|
|
2512
|
+
5. **Theme shortcut**: Press `T` with no modifiers while the page has focus to switch between light and dark themes. The shortcut is disabled when a theme is forced.
|
|
2513
|
+
|
|
2514
|
+
The shortcut is part of the package provider, so generated consumer projects get it by default. It does not run while an input, button, link, or other element has focus.
|
|
2505
2515
|
|
|
2506
2516
|
## Usage
|
|
2507
2517
|
|
|
@@ -4004,9 +4014,25 @@ Once open, users can:
|
|
|
4004
4014
|
- Ask questions about any part of your documentation
|
|
4005
4015
|
- View the documentation pages used as sources for each answer
|
|
4006
4016
|
- Copy an answer as Markdown
|
|
4017
|
+
- Share a conversation with a public link when the site configures chat sharing
|
|
4007
4018
|
- Expand the desktop panel to fill the viewport
|
|
4008
4019
|
- Get step-by-step guidance on complex topics
|
|
4009
4020
|
|
|
4021
|
+
### Share a conversation
|
|
4022
|
+
|
|
4023
|
+
To show **Share chat** in the chat header, set `ai.share` to an app-local POST endpoint and the public route that displays shared conversations:
|
|
4024
|
+
|
|
4025
|
+
```tsx title="geistdocs.tsx"
|
|
4026
|
+
export const ai = {
|
|
4027
|
+
share: {
|
|
4028
|
+
endpoint: "/api/ai-chat/share",
|
|
4029
|
+
path: "/ai-chat",
|
|
4030
|
+
},
|
|
4031
|
+
};
|
|
4032
|
+
```
|
|
4033
|
+
|
|
4034
|
+
Geistdocs sends the endpoint a JSON body with `messages`, `hostPath`, and an optional `summary` containing the first user message. The endpoint must persist the conversation and return `{ "shareId": "..." }`. Geistdocs copies a link to `<path>/<shareId>`; your app must serve that public route and load the saved conversation. The endpoint and path are app-local, and Geistdocs adds `basePath` when needed. Chat sharing is disabled when `ai.share` is unset.
|
|
4035
|
+
|
|
4010
4036
|
## Control Ask AI from your own components
|
|
4011
4037
|
|
|
4012
4038
|
`useGeistdocsChat` from `@vercel/geistdocs/controls` opens, closes, and sends messages to the Ask AI chat from your own client components. Call it from any component rendered inside `GeistdocsProvider`, such as a custom header, a callout, or an MDX component.
|
package/docs/manifest.json
CHANGED
package/docs/pages/ask-ai.md
CHANGED
|
@@ -52,9 +52,25 @@ Once open, users can:
|
|
|
52
52
|
- Ask questions about any part of your documentation
|
|
53
53
|
- View the documentation pages used as sources for each answer
|
|
54
54
|
- Copy an answer as Markdown
|
|
55
|
+
- Share a conversation with a public link when the site configures chat sharing
|
|
55
56
|
- Expand the desktop panel to fill the viewport
|
|
56
57
|
- Get step-by-step guidance on complex topics
|
|
57
58
|
|
|
59
|
+
### Share a conversation
|
|
60
|
+
|
|
61
|
+
To show **Share chat** in the chat header, set `ai.share` to an app-local POST endpoint and the public route that displays shared conversations:
|
|
62
|
+
|
|
63
|
+
```tsx title="geistdocs.tsx"
|
|
64
|
+
export const ai = {
|
|
65
|
+
share: {
|
|
66
|
+
endpoint: "/api/ai-chat/share",
|
|
67
|
+
path: "/ai-chat",
|
|
68
|
+
},
|
|
69
|
+
};
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
Geistdocs sends the endpoint a JSON body with `messages`, `hostPath`, and an optional `summary` containing the first user message. The endpoint must persist the conversation and return `{ "shareId": "..." }`. Geistdocs copies a link to `<path>/<shareId>`; your app must serve that public route and load the saved conversation. The endpoint and path are app-local, and Geistdocs adds `basePath` when needed. Chat sharing is disabled when `ai.share` is unset.
|
|
73
|
+
|
|
58
74
|
## Control Ask AI from your own components
|
|
59
75
|
|
|
60
76
|
`useGeistdocsChat` from `@vercel/geistdocs/controls` opens, closes, and sends messages to the Ask AI chat from your own client components. Call it from any component rendered inside `GeistdocsProvider`, such as a custom header, a callout, or an MDX component.
|
|
@@ -231,6 +231,7 @@ The `ai` config also controls the chat panel and its route:
|
|
|
231
231
|
| `suggestions` | `(string \| { text: string; icon?: ReactNode })[]` | `[]` | Suggested prompts. The first four distinct prompts are shown, and strings render without an icon. |
|
|
232
232
|
| `history.retentionDays` | `number` | `30` | Days a stored conversation is kept after its most recent message. `0` stores no history, and `Infinity` never expires it. |
|
|
233
233
|
| `messageFeedback` | `boolean` | `false` | Show thumbs up and thumbs down buttons on finished answers and send votes to the Geistdocs feedback service. |
|
|
234
|
+
| `share` | `GeistdocsAIShareConfig` | `undefined` | Show a Share chat action backed by your persistence endpoint and public shared-conversation route. |
|
|
234
235
|
| `toolLabels` | `Record<string, string>` | `{}` | Activity label shown while a named tool runs, such as `{ web_search: "Searching..." }`. Other tools show `Running <tool name>...`. |
|
|
235
236
|
|
|
236
237
|
```tsx title="geistdocs.tsx"
|
|
@@ -239,9 +240,15 @@ export const ai = {
|
|
|
239
240
|
title: "Ask Acme AI",
|
|
240
241
|
history: { retentionDays: 7 },
|
|
241
242
|
messageFeedback: true,
|
|
243
|
+
share: {
|
|
244
|
+
endpoint: "/api/ai-chat/share",
|
|
245
|
+
path: "/ai-chat",
|
|
246
|
+
},
|
|
242
247
|
};
|
|
243
248
|
```
|
|
244
249
|
|
|
250
|
+
The endpoint receives `{ messages, hostPath, summary? }` and must return `{ shareId }`. The public route at `path/<shareId>` must display the saved conversation. Both paths are app-local; Geistdocs adds `basePath` automatically. See [Share a conversation](/docs/ask-ai#share-a-conversation) for the full contract.
|
|
251
|
+
|
|
245
252
|
See [Ask AI](/docs/ask-ai) for the full eve agent mode behavior, including authentication, for moving the chat route adapter when you set `endpoint`, for what a `messageFeedback` vote sends, and for matching a production Vertex or eve setup with `toolLabels` and the server-only `createChatRoute` options. Read [Improve Ask AI answers with Mixedbread](/docs/mixedbread-retrieval) before enabling semantic retrieval.
|
|
246
253
|
|
|
247
254
|
Use [Versioned docs](/docs/versioned-docs) for versioned source setup and [Proxy and markdown routes](/docs/proxy) for route mappings.
|
package/docs/pages/provider.md
CHANGED
|
@@ -25,6 +25,9 @@ The provider handles these behaviors:
|
|
|
25
25
|
2. **Analytics**: Integrates Vercel Analytics and Speed Insights when the local adapter includes them.
|
|
26
26
|
3. **Search**: Configures the search dialog and connects it to your search API.
|
|
27
27
|
4. **Ask AI**: Provides the client state used by the chat sidebar and page actions.
|
|
28
|
+
5. **Theme shortcut**: Press `T` with no modifiers while the page has focus to switch between light and dark themes. The shortcut is disabled when a theme is forced.
|
|
29
|
+
|
|
30
|
+
The shortcut is part of the package provider, so generated consumer projects get it by default. It does not run while an input, button, link, or other element has focus.
|
|
28
31
|
|
|
29
32
|
## Usage
|
|
30
33
|
|
package/package.json
CHANGED
|
@@ -50,9 +50,25 @@ Once open, users can:
|
|
|
50
50
|
- Ask questions about any part of your documentation
|
|
51
51
|
- View the documentation pages used as sources for each answer
|
|
52
52
|
- Copy an answer as Markdown
|
|
53
|
+
- Share a conversation with a public link when the site configures chat sharing
|
|
53
54
|
- Expand the desktop panel to fill the viewport
|
|
54
55
|
- Get step-by-step guidance on complex topics
|
|
55
56
|
|
|
57
|
+
### Share a conversation
|
|
58
|
+
|
|
59
|
+
To show **Share chat** in the chat header, set `ai.share` to an app-local POST endpoint and the public route that displays shared conversations:
|
|
60
|
+
|
|
61
|
+
```tsx title="geistdocs.tsx"
|
|
62
|
+
export const ai = {
|
|
63
|
+
share: {
|
|
64
|
+
endpoint: "/api/ai-chat/share",
|
|
65
|
+
path: "/ai-chat",
|
|
66
|
+
},
|
|
67
|
+
};
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
Geistdocs sends the endpoint a JSON body with `messages`, `hostPath`, and an optional `summary` containing the first user message. The endpoint must persist the conversation and return `{ "shareId": "..." }`. Geistdocs copies a link to `<path>/<shareId>`; your app must serve that public route and load the saved conversation. The endpoint and path are app-local, and Geistdocs adds `basePath` when needed. Chat sharing is disabled when `ai.share` is unset.
|
|
71
|
+
|
|
56
72
|
## Control Ask AI from your own components
|
|
57
73
|
|
|
58
74
|
`useGeistdocsChat` from `@vercel/geistdocs/controls` opens, closes, and sends messages to the Ask AI chat from your own client components. Call it from any component rendered inside `GeistdocsProvider`, such as a custom header, a callout, or an MDX component.
|
|
@@ -229,6 +229,7 @@ The `ai` config also controls the chat panel and its route:
|
|
|
229
229
|
| `suggestions` | `(string \| { text: string; icon?: ReactNode })[]` | `[]` | Suggested prompts. The first four distinct prompts are shown, and strings render without an icon. |
|
|
230
230
|
| `history.retentionDays` | `number` | `30` | Days a stored conversation is kept after its most recent message. `0` stores no history, and `Infinity` never expires it. |
|
|
231
231
|
| `messageFeedback` | `boolean` | `false` | Show thumbs up and thumbs down buttons on finished answers and send votes to the Geistdocs feedback service. |
|
|
232
|
+
| `share` | `GeistdocsAIShareConfig` | `undefined` | Show a Share chat action backed by your persistence endpoint and public shared-conversation route. |
|
|
232
233
|
| `toolLabels` | `Record<string, string>` | `{}` | Activity label shown while a named tool runs, such as `{ web_search: "Searching..." }`. Other tools show `Running <tool name>...`. |
|
|
233
234
|
|
|
234
235
|
```tsx title="geistdocs.tsx"
|
|
@@ -237,9 +238,15 @@ export const ai = {
|
|
|
237
238
|
title: "Ask Acme AI",
|
|
238
239
|
history: { retentionDays: 7 },
|
|
239
240
|
messageFeedback: true,
|
|
241
|
+
share: {
|
|
242
|
+
endpoint: "/api/ai-chat/share",
|
|
243
|
+
path: "/ai-chat",
|
|
244
|
+
},
|
|
240
245
|
};
|
|
241
246
|
```
|
|
242
247
|
|
|
248
|
+
The endpoint receives `{ messages, hostPath, summary? }` and must return `{ shareId }`. The public route at `path/<shareId>` must display the saved conversation. Both paths are app-local; Geistdocs adds `basePath` automatically. See [Share a conversation](/docs/ask-ai#share-a-conversation) for the full contract.
|
|
249
|
+
|
|
243
250
|
See [Ask AI](/docs/ask-ai) for the full eve agent mode behavior, including authentication, for moving the chat route adapter when you set `endpoint`, for what a `messageFeedback` vote sends, and for matching a production Vertex or eve setup with `toolLabels` and the server-only `createChatRoute` options. Read [Improve Ask AI answers with Mixedbread](/docs/mixedbread-retrieval) before enabling semantic retrieval.
|
|
244
251
|
|
|
245
252
|
Use [Versioned docs](/docs/versioned-docs) for versioned source setup and [Proxy and markdown routes](/docs/proxy) for route mappings.
|
|
@@ -23,6 +23,9 @@ The provider handles these behaviors:
|
|
|
23
23
|
2. **Analytics**: Integrates Vercel Analytics and Speed Insights when the local adapter includes them.
|
|
24
24
|
3. **Search**: Configures the search dialog and connects it to your search API.
|
|
25
25
|
4. **Ask AI**: Provides the client state used by the chat sidebar and page actions.
|
|
26
|
+
5. **Theme shortcut**: Press `T` with no modifiers while the page has focus to switch between light and dark themes. The shortcut is disabled when a theme is forced.
|
|
27
|
+
|
|
28
|
+
The shortcut is part of the package provider, so generated consumer projects get it by default. It does not run while an input, button, link, or other element has focus.
|
|
26
29
|
|
|
27
30
|
## Usage
|
|
28
31
|
|
package/template/package.json
CHANGED