@vercel/geistdocs 1.25.1-canary.bd8995b → 1.25.1-canary.d2f4449
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/cli/index.js +1 -1
- package/dist/components/blockquote.d.ts +3 -0
- package/dist/components/blockquote.d.ts.map +1 -0
- package/dist/components/blockquote.js +3 -0
- package/dist/components/callout.d.ts +13 -10
- package/dist/components/callout.d.ts.map +1 -1
- package/dist/components/callout.js +6 -6
- package/dist/components/code-block-tabs.d.ts.map +1 -1
- package/dist/components/code-block-tabs.js +3 -1
- package/dist/components/code-block.d.ts.map +1 -1
- package/dist/components/code-block.js +1 -1
- package/dist/components/command-prompt.d.ts.map +1 -1
- package/dist/components/command-prompt.js +15 -22
- package/dist/components/copy-prompt.d.ts +2 -1
- package/dist/components/copy-prompt.d.ts.map +1 -1
- package/dist/components/copy-prompt.js +2 -2
- package/dist/components/heading.d.ts +7 -0
- package/dist/components/heading.d.ts.map +1 -0
- package/dist/components/heading.js +14 -0
- package/dist/components/image.d.ts +19 -0
- package/dist/components/image.d.ts.map +1 -0
- package/dist/components/image.js +9 -0
- package/dist/components/table.d.ts +3 -0
- package/dist/components/table.d.ts.map +1 -0
- package/dist/components/table.js +3 -0
- package/dist/controls.d.ts.map +1 -1
- package/dist/controls.js +4 -3
- package/dist/internal/chat/activity.d.ts +20 -0
- package/dist/internal/chat/activity.d.ts.map +1 -0
- package/dist/internal/chat/activity.js +43 -0
- package/dist/internal/chat/context.d.ts +2 -0
- package/dist/internal/chat/context.d.ts.map +1 -1
- package/dist/internal/chat/context.js +24 -3
- package/dist/internal/chat/dots-spinner.d.ts.map +1 -1
- package/dist/internal/chat/dots-spinner.js +15 -9
- package/dist/internal/chat/loading-skeleton.d.ts +7 -0
- package/dist/internal/chat/loading-skeleton.d.ts.map +1 -0
- package/dist/internal/chat/loading-skeleton.js +46 -0
- package/dist/internal/chat/message-metadata.d.ts.map +1 -1
- package/dist/internal/chat/message-metadata.js +15 -30
- package/dist/internal/chat/message-sources.d.ts +3 -0
- package/dist/internal/chat/message-sources.d.ts.map +1 -0
- package/dist/internal/chat/message-sources.js +23 -0
- package/dist/internal/chat/message.d.ts.map +1 -1
- package/dist/internal/chat/message.js +59 -5
- package/dist/internal/chat/shell.d.ts.map +1 -1
- package/dist/internal/chat/shell.js +17 -17
- package/dist/internal/chat/source-chunks.d.ts +9 -0
- package/dist/internal/chat/source-chunks.d.ts.map +1 -0
- package/dist/internal/chat/source-chunks.js +7 -0
- package/dist/internal/chat/sources.d.ts +1 -1
- package/dist/internal/chat/sources.d.ts.map +1 -1
- package/dist/internal/chat/sources.js +7 -1
- package/dist/internal/link-href.d.ts +13 -0
- package/dist/internal/link-href.d.ts.map +1 -0
- package/dist/internal/link-href.js +51 -0
- package/dist/internal/mdx-to-markdown.d.ts +3 -0
- package/dist/internal/mdx-to-markdown.d.ts.map +1 -0
- package/dist/internal/mdx-to-markdown.js +134 -0
- package/dist/internal/mousedown-navigation-utils.d.ts +5 -0
- package/dist/internal/mousedown-navigation-utils.d.ts.map +1 -0
- package/dist/internal/mousedown-navigation-utils.js +95 -0
- package/dist/internal/mousedown-navigation.d.ts +10 -0
- package/dist/internal/mousedown-navigation.d.ts.map +1 -0
- package/dist/internal/mousedown-navigation.js +42 -0
- package/dist/internal/navbar/desktop-menu.js +1 -1
- package/dist/internal/navbar/mobile-menu.d.ts.map +1 -1
- package/dist/internal/navbar/mobile-menu.js +8 -13
- package/dist/internal/navbar/navbar-shell.d.ts.map +1 -1
- package/dist/internal/navbar/navbar-shell.js +2 -1
- package/dist/internal/page-actions-client.d.ts.map +1 -1
- package/dist/internal/page-actions-client.js +36 -32
- package/dist/internal/provider-client.d.ts.map +1 -1
- package/dist/internal/provider-client.js +29 -5
- package/dist/internal/react-node-text.d.ts +4 -0
- package/dist/internal/react-node-text.d.ts.map +1 -0
- package/dist/internal/react-node-text.js +11 -0
- package/dist/internal/search.d.ts.map +1 -1
- package/dist/internal/search.js +1 -1
- package/dist/internal/sidebar-responsive.d.ts +0 -1
- package/dist/internal/sidebar-responsive.d.ts.map +1 -1
- package/dist/internal/sidebar-responsive.js +0 -9
- package/dist/internal/sidebar-tree.d.ts.map +1 -1
- package/dist/internal/sidebar-tree.js +6 -1
- package/dist/internal/sidebar.d.ts.map +1 -1
- package/dist/internal/sidebar.js +78 -49
- package/dist/internal/table-of-contents.d.ts.map +1 -1
- package/dist/internal/table-of-contents.js +1 -1
- package/dist/internal/toc-items.d.ts.map +1 -1
- package/dist/internal/toc-items.js +18 -7
- package/dist/internal/ui/dropdown-menu.js +6 -6
- package/dist/internal/ui/navigation-menu.js +2 -2
- package/dist/internal/use-mobile.d.ts.map +1 -1
- package/dist/internal/use-mobile.js +2 -12
- package/dist/layout.d.ts +1 -0
- package/dist/layout.d.ts.map +1 -1
- package/dist/layout.js +2 -0
- package/dist/mdx.d.ts.map +1 -1
- package/dist/mdx.js +15 -1
- package/dist/pages/docs.d.ts.map +1 -1
- package/dist/pages/docs.js +17 -4
- package/dist/routes/chat.d.ts +1 -1
- package/dist/routes/chat.d.ts.map +1 -1
- package/dist/routes/chat.js +31 -14
- package/dist/routes/llms.d.ts +1 -1
- package/dist/routes/llms.d.ts.map +1 -1
- package/dist/routes/llms.js +12 -2
- package/dist/source.d.ts +10 -1
- package/dist/source.d.ts.map +1 -1
- package/dist/source.js +75 -34
- package/dist/versions.js +2 -2
- package/docs/agents.md +4 -3
- package/docs/llms.txt +378 -37
- package/docs/manifest.json +12 -3
- package/docs/pages/ask-ai.md +2 -2
- package/docs/pages/deployment.md +30 -5
- package/docs/pages/getting-started.md +38 -12
- package/docs/pages/guides/nested-navigation.md +1 -1
- package/docs/pages/md.md +25 -6
- package/docs/pages/migration-2.md +106 -0
- package/docs/pages/migration.md +5 -2
- package/docs/pages/syntax.md +163 -6
- package/docs/sitemap.md +3 -2
- package/package.json +12 -5
- package/template/app/[lang]/layout.tsx +4 -0
- package/template/app/styles/geistdocs.css +1 -1
- package/template/components/ui/button.tsx +1 -1
- package/template/content/docs/ask-ai.cn.mdx +2 -2
- package/template/content/docs/ask-ai.mdx +2 -2
- package/template/content/docs/deployment.mdx +31 -6
- package/template/content/docs/getting-started.mdx +39 -13
- package/template/content/docs/guides/nested-navigation.mdx +1 -1
- package/template/content/docs/md.mdx +25 -6
- package/template/content/docs/meta.json +1 -0
- package/template/content/docs/migration-2.mdx +106 -0
- package/template/content/docs/migration.mdx +5 -1
- package/template/content/docs/syntax.mdx +169 -6
- package/template/next.config.ts +9 -0
- package/template/package.json +4 -4
- package/theme.css +39 -105
package/dist/pages/docs.js
CHANGED
|
@@ -7,6 +7,7 @@ import { notFound } from "next/navigation";
|
|
|
7
7
|
import { getPublicPath, withBasePath } from "../config";
|
|
8
8
|
import { DocsPageErrorBoundary } from "../internal/docs-page-error-boundary";
|
|
9
9
|
import { resolveDocumentTitle } from "../internal/document-title";
|
|
10
|
+
import { resolveLinkHref, stripBasePathFromHref } from "../internal/link-href";
|
|
10
11
|
import { resolvePageMarkdownUrl as resolveInternalPageMarkdownUrl } from "../internal/markdown-url.js";
|
|
11
12
|
import { createPageActions as createInternalPageActions } from "../internal/page-actions";
|
|
12
13
|
import { GeistdocsPageActions, GeistdocsTableOfContentsActions, } from "../internal/page-actions-client";
|
|
@@ -15,7 +16,14 @@ import { getPageFooterItems, PageFooter } from "../internal/page-footer";
|
|
|
15
16
|
import { GeistdocsTableOfContents } from "../internal/table-of-contents";
|
|
16
17
|
import { createMdxComponents } from "../mdx";
|
|
17
18
|
import { getPageRobots, } from "../page-visibility";
|
|
18
|
-
const
|
|
19
|
+
const renderPrefetchedDocsLink = (siteUrl, basePath, { children, className, href, rel, target, ...props }) => {
|
|
20
|
+
const originalHref = String(href ?? "");
|
|
21
|
+
const resolved = resolveLinkHref(originalHref, siteUrl);
|
|
22
|
+
const linkHref = resolved.href === originalHref
|
|
23
|
+
? resolved.href
|
|
24
|
+
: stripBasePathFromHref(resolved.href, basePath);
|
|
25
|
+
return (_jsx(Link, { ...props, className: cn("font-normal text-gray-1000! underline decoration-1 decoration-gray-700 underline-offset-4 hover:text-gray-1000! hover:decoration-gray-1000 hover:opacity-100!", className), href: linkHref, prefetch: !resolved.external, rel: resolved.external ? rel : undefined, target: resolved.external ? target : undefined, children: children }));
|
|
26
|
+
};
|
|
19
27
|
export const resolvePageMarkdownUrl = (options) => resolveInternalPageMarkdownUrl(options);
|
|
20
28
|
const DocsTitle = ({ className, ...props }) => (_jsx(FumadocsDocsTitle, { className: cn("mb-4 text-balance", className), ...props }));
|
|
21
29
|
const DocsDescription = ({ className, ...props }) => (_jsx(FumadocsDocsDescription, { className: cn("text-gray-900", className), ...props }));
|
|
@@ -26,6 +34,7 @@ const hasTableOfContentsActions = (config, extraActions) => config.pageActions?.
|
|
|
26
34
|
config.feedback?.enabled !== false ||
|
|
27
35
|
extraActions.length > 0;
|
|
28
36
|
export const createDocsPage = ({ config, source, mdx, pageActions = createInternalPageActions({ config }), filterStaticParams, getMarkdownUrl, getPageUrl, getPublicPageUrl, metadata, openGraph, renderTop, resolveLink, tableOfContent, tableOfContentPopover, }) => {
|
|
37
|
+
const DocsLink = renderPrefetchedDocsLink.bind(null, config.siteUrl, config.basePath);
|
|
29
38
|
const resolvePageUrls = (page, params) => {
|
|
30
39
|
const pageUrl = getPageUrl?.({ page, params }) ?? page.url;
|
|
31
40
|
const publicPageUrl = getPublicPageUrl?.({ page, params, pageUrl }) ??
|
|
@@ -48,7 +57,7 @@ export const createDocsPage = ({ config, source, mdx, pageActions = createIntern
|
|
|
48
57
|
}
|
|
49
58
|
const data = page.data;
|
|
50
59
|
const MDX = data.body;
|
|
51
|
-
const defaultLink = createRelativeLink(source.source, page,
|
|
60
|
+
const defaultLink = createRelativeLink(source.source, page, DocsLink);
|
|
52
61
|
const link = resolveLink
|
|
53
62
|
? resolveLink({ link: defaultLink, page, source })
|
|
54
63
|
: defaultLink;
|
|
@@ -91,9 +100,10 @@ export const createDocsPage = ({ config, source, mdx, pageActions = createIntern
|
|
|
91
100
|
}) ?? [])
|
|
92
101
|
: [];
|
|
93
102
|
const hasTocActions = hasTableOfContentsActions(pageActions.config, footerActions);
|
|
103
|
+
const hasTocLinks = Boolean(data.toc?.length);
|
|
94
104
|
// Actions stay adjacent to the table of contents; the app-provided
|
|
95
105
|
// footer (promos and other custom content) renders below them.
|
|
96
|
-
const tocFooter = (_jsxs(_Fragment, { children: [hasTocActions ? (_jsx("div", { className: "mt-4 border-gray-alpha-400 border-t pt-4", children: _jsx("nav", { "aria-label": "Page actions", className: "flex min-w-0 flex-col gap-1", children: _jsx(GeistdocsTableOfContentsActions, { config: pageActions.config, extraActions: footerActions }) }) })) : null, _jsx(TocFooterSlot, { children: tableOfContent?.footer })] }));
|
|
106
|
+
const tocFooter = (_jsxs(_Fragment, { children: [hasTocLinks && hasTocActions ? (_jsx("div", { className: "mt-4 border-gray-alpha-400 border-t pt-4", children: _jsx("nav", { "aria-label": "Page actions", className: "flex min-w-0 flex-col gap-1", children: _jsx(GeistdocsTableOfContentsActions, { config: pageActions.config, extraActions: footerActions }) }) })) : null, _jsx(TocFooterSlot, { children: tableOfContent?.footer })] }));
|
|
97
107
|
const tocComponent = tableOfContent?.component ?? (_jsx(GeistdocsTableOfContents, { footer: tocFooter, header: tableOfContent?.header, toc: data.toc ?? [] }));
|
|
98
108
|
return (_jsxs(FumadocsDocsPage, { breadcrumb: {
|
|
99
109
|
component: (_jsx(PageBreadcrumb, { tree: source.source.getPageTree(lang), url: page.url })),
|
|
@@ -102,7 +112,10 @@ export const createDocsPage = ({ config, source, mdx, pageActions = createIntern
|
|
|
102
112
|
single: true,
|
|
103
113
|
...tableOfContent,
|
|
104
114
|
component: tocComponent,
|
|
105
|
-
}, tableOfContentPopover:
|
|
115
|
+
}, tableOfContentPopover: {
|
|
116
|
+
enabled: false,
|
|
117
|
+
...tableOfContentPopover,
|
|
118
|
+
}, toc: data.toc, children: [renderTop?.({
|
|
106
119
|
data,
|
|
107
120
|
markdown: markdown ?? "",
|
|
108
121
|
markdownUrl,
|
package/dist/routes/chat.d.ts
CHANGED
|
@@ -29,7 +29,7 @@ interface CreateChatRouteOptions {
|
|
|
29
29
|
* Accepts any AI SDK `LanguageModel`, including AI Gateway model strings
|
|
30
30
|
* such as `"xai/grok-4.5"`. Ignored in proxy and eve agent modes, where
|
|
31
31
|
* the external service selects the model. Defaults to
|
|
32
|
-
* `"openai/gpt-
|
|
32
|
+
* `"openai/gpt-5.6-sol"`.
|
|
33
33
|
*/
|
|
34
34
|
model?: LanguageModel;
|
|
35
35
|
proxy?: ChatProxyConfig;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"chat.d.ts","sourceRoot":"","sources":["../../src/routes/chat.ts"],"names":[],"mappings":"AACA,OAAO,EAIL,KAAK,aAAa,EAQnB,MAAM,IAAI,CAAC;AAGZ,OAAO,EAAE,KAAK,eAAe,EAAiB,MAAM,WAAW,CAAC;
|
|
1
|
+
{"version":3,"file":"chat.d.ts","sourceRoot":"","sources":["../../src/routes/chat.ts"],"names":[],"mappings":"AACA,OAAO,EAIL,KAAK,aAAa,EAQnB,MAAM,IAAI,CAAC;AAGZ,OAAO,EAAE,KAAK,eAAe,EAAiB,MAAM,WAAW,CAAC;AAahE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAEvD,KAAK,YAAY,GAAG,qBAAqB,CAAC;AAyB1C,UAAU,eAAe;IACvB,OAAO,CAAC,EAAE,WAAW,GAAG,CAAC,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC;IACnE,GAAG,EAAE,MAAM,CAAC;CACb;AAED,UAAU,mBAAmB;IAC3B;;;;;OAKG;IACH,OAAO,CAAC,EAAE,WAAW,GAAG,CAAC,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC;IACnE,qEAAqE;IACrE,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,UAAU,sBAAsB;IAC9B,MAAM,EAAE,IAAI,CACV,eAAe,EACf,IAAI,GAAG,UAAU,GAAG,iBAAiB,GAAG,cAAc,CACvD,CAAC;IACF;;;OAGG;IACH,QAAQ,CAAC,EAAE,mBAAmB,CAAC;IAC/B;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;CAC1B;AAk0BD,eAAO,MAAM,eAAe,GAAI,sDAO7B,sBAAsB;gBASE,OAAO;;CA+KjC,CAAC"}
|
package/dist/routes/chat.js
CHANGED
|
@@ -3,9 +3,10 @@ import { convertToModelMessages, createUIMessageStream, createUIMessageStreamRes
|
|
|
3
3
|
import { initAdvancedSearch } from "fumadocs-core/search/server";
|
|
4
4
|
import { z } from "zod";
|
|
5
5
|
import { getPublicPath } from "../config";
|
|
6
|
+
import { createSourceChunk, createSourceChunks, } from "../internal/chat/source-chunks";
|
|
6
7
|
import { buildEveAgentTranscript, capLastUserMessageText, getEveAgentSessionHandle, resolveEveAgentUrl, runEveAgentTurn, } from "../internal/eve-agent";
|
|
7
8
|
import { isPageVisibleForSurface } from "../page-visibility";
|
|
8
|
-
const DEFAULT_CHAT_MODEL = "openai/gpt-
|
|
9
|
+
const DEFAULT_CHAT_MODEL = "openai/gpt-5.6-sol";
|
|
9
10
|
const MAX_CONTEXT_CHARS = 1500;
|
|
10
11
|
const MAX_EVE_AGENT_MESSAGE_CHARS = 4000;
|
|
11
12
|
const MAX_PROXY_RELATED_PAGES = 5;
|
|
@@ -178,12 +179,6 @@ const getCurrentPageDoc = async ({ basePath, currentRoute, lang, pageContext, so
|
|
|
178
179
|
};
|
|
179
180
|
};
|
|
180
181
|
const isFirstUserMessage = (messages) => messages.filter((message) => message.role === "user").length === 1;
|
|
181
|
-
const createSourceChunks = (docs) => docs.map((doc, index) => ({
|
|
182
|
-
type: "source-url",
|
|
183
|
-
sourceId: `doc-${index}-${doc.slug}`,
|
|
184
|
-
url: doc.url,
|
|
185
|
-
title: doc.title,
|
|
186
|
-
}));
|
|
187
182
|
const buildProxyMessages = async ({ actualMessages, config, currentRoute, defaultLanguage, languages, pageContext, routeSources, }) => {
|
|
188
183
|
if (!isFirstUserMessage(actualMessages)) {
|
|
189
184
|
return { messages: actualMessages, sourceDocs: [] };
|
|
@@ -406,12 +401,7 @@ const createTools = (writer, sources, defaultLanguage, basePath) => {
|
|
|
406
401
|
return `No documentation found for query: "${query}"`;
|
|
407
402
|
}
|
|
408
403
|
for (const [index, doc] of trimmedResults.entries()) {
|
|
409
|
-
writer.write(
|
|
410
|
-
type: "source-url",
|
|
411
|
-
sourceId: `doc-${index}-${doc.slug}`,
|
|
412
|
-
url: doc.url,
|
|
413
|
-
title: doc.title,
|
|
414
|
-
});
|
|
404
|
+
writer.write(createSourceChunk(doc, index));
|
|
415
405
|
}
|
|
416
406
|
const formattedResultsString = trimmedResults
|
|
417
407
|
.map((doc) => `${formatDocForContext(doc)}\n\n---\n`)
|
|
@@ -447,7 +437,15 @@ const createTools = (writer, sources, defaultLanguage, basePath) => {
|
|
|
447
437
|
if (!doc) {
|
|
448
438
|
return `Documentation page not found: "${slug}"`;
|
|
449
439
|
}
|
|
450
|
-
|
|
440
|
+
const content = await doc.source.getPageMarkdown(doc.page);
|
|
441
|
+
const data = getPageData(doc.page);
|
|
442
|
+
const url = getPublicPath(doc.page.url, basePath);
|
|
443
|
+
writer.write(createSourceChunk({
|
|
444
|
+
slug: doc.page.url,
|
|
445
|
+
title: data.title ?? doc.page.url,
|
|
446
|
+
url,
|
|
447
|
+
}));
|
|
448
|
+
return content;
|
|
451
449
|
},
|
|
452
450
|
});
|
|
453
451
|
const list_docs = tool({
|
|
@@ -604,10 +602,26 @@ export const createChatRoute = ({ config, eveAgent, model = DEFAULT_CHAT_MODEL,
|
|
|
604
602
|
return createUIMessageStreamResponse({ stream });
|
|
605
603
|
}
|
|
606
604
|
let processedMessages = actualMessages;
|
|
605
|
+
let localSourceDocs = [];
|
|
607
606
|
if (pageContext && actualMessages.length > 0) {
|
|
608
607
|
const lastMessage = actualMessages.at(-1);
|
|
609
608
|
if (lastMessage?.role === "user") {
|
|
610
609
|
const userQuestion = getMessageText(lastMessage);
|
|
610
|
+
const contextDoc = await getCurrentPageDoc({
|
|
611
|
+
basePath: config.basePath,
|
|
612
|
+
currentRoute,
|
|
613
|
+
lang: getRequestLanguage({
|
|
614
|
+
basePath: config.basePath,
|
|
615
|
+
currentRoute,
|
|
616
|
+
defaultLanguage,
|
|
617
|
+
languages,
|
|
618
|
+
}),
|
|
619
|
+
pageContext,
|
|
620
|
+
sources: routeSources,
|
|
621
|
+
});
|
|
622
|
+
if (contextDoc) {
|
|
623
|
+
localSourceDocs = [contextDoc];
|
|
624
|
+
}
|
|
611
625
|
processedMessages = [
|
|
612
626
|
...actualMessages.slice(0, -1),
|
|
613
627
|
{
|
|
@@ -625,6 +639,9 @@ export const createChatRoute = ({ config, eveAgent, model = DEFAULT_CHAT_MODEL,
|
|
|
625
639
|
const stream = createUIMessageStream({
|
|
626
640
|
originalMessages: messages,
|
|
627
641
|
execute: async ({ writer }) => {
|
|
642
|
+
for (const chunk of createSourceChunks(localSourceDocs)) {
|
|
643
|
+
writer.write(chunk);
|
|
644
|
+
}
|
|
628
645
|
const modelMessages = await convertToModelMessages(processedMessages);
|
|
629
646
|
const result = streamText({
|
|
630
647
|
model,
|
package/dist/routes/llms.d.ts
CHANGED
|
@@ -30,7 +30,7 @@ export declare const createLlmsRoute: ({ filterPage, source, sources, transform,
|
|
|
30
30
|
revalidate: false;
|
|
31
31
|
};
|
|
32
32
|
export interface CreateDocsMarkdownRouteOptions {
|
|
33
|
-
config?: Pick<GeistdocsConfig, "basePath" | "defaultLanguage" | "translations">;
|
|
33
|
+
config?: Pick<GeistdocsConfig, "basePath" | "defaultLanguage" | "siteUrl" | "translations">;
|
|
34
34
|
filterStaticParams?: (params: DocsMarkdownParams) => boolean;
|
|
35
35
|
/** Customize the agent-readable Markdown response for missing pages, or disable it. */
|
|
36
36
|
notFound?: false | MarkdownNotFoundOptions;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"llms.d.ts","sourceRoot":"","sources":["../../src/routes/llms.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EACL,KAAK,eAAe,EAIrB,MAAM,cAAc,CAAC;AAStB,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAE1D,KAAK,YAAY,GAAG,qBAAqB,CAAC;AAC1C,KAAK,aAAa,GAAG,WAAW,CAAC,UAAU,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"llms.d.ts","sourceRoot":"","sources":["../../src/routes/llms.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EACL,KAAK,eAAe,EAIrB,MAAM,cAAc,CAAC;AAStB,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAE1D,KAAK,YAAY,GAAG,qBAAqB,CAAC;AAC1C,KAAK,aAAa,GAAG,WAAW,CAAC,UAAU,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;AAehF,UAAU,kBAAkB;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,UAAU,wBAAwB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,aAAa,CAAC;IACpB,MAAM,EAAE,YAAY,CAAC;CACtB;AAED,KAAK,iBAAiB,GAAG,CACvB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,wBAAwB,KAC9B,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;AAE9B,UAAU,sBAAsB;IAC9B,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC;IACzE,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;IACzB,SAAS,CAAC,EAAE,iBAAiB,CAAC;CAC/B;AAqOD,eAAO,MAAM,eAAe,GAAI,6CAK7B,sBAAsB;gBAIf,WAAW,cACL;QAAE,MAAM,EAAE,OAAO,CAAC;YAAE,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC,CAAA;KAAE;;CAoCpD,CAAC;AAEF,MAAM,WAAW,8BAA8B;IAC7C,MAAM,CAAC,EAAE,IAAI,CACX,eAAe,EACf,UAAU,GAAG,iBAAiB,GAAG,SAAS,GAAG,cAAc,CAC5D,CAAC;IACF,kBAAkB,CAAC,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,OAAO,CAAC;IAC7D,uFAAuF;IACvF,QAAQ,CAAC,EAAE,KAAK,GAAG,uBAAuB,CAAC;IAC3C,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;IACzB,SAAS,CAAC,EAAE,iBAAiB,CAAC;CAC/B;AAED,MAAM,WAAW,uBAAuB;IACtC,uDAAuD;IACvD,kBAAkB,CAAC,EAAE,CAAC,OAAO,EAAE;QAC7B,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,aAAa,CAAC;QACpB,MAAM,EAAE,YAAY,CAAC;KACtB,KAAK,MAAM,CAAC;IACb;;;OAGG;IACH,gBAAgB,CAAC,EAAE,CAAC,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,EAAE,CAAA;KAAE,KAAK,MAAM,CAAC;IACzE,oDAAoD;IACpD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,MAAM,CAAC,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;CAC1B;AAED,eAAO,MAAM,uBAAuB,GAAI,wFAOrC,8BAA8B;mBAqLpB,OAAO,cACJ;QAAE,MAAM,EAAE,OAAO,CAAC;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;SAAE,CAAC,CAAA;KAAE;yCAmDjE;QACD,MAAM,CAAC,EAAE,OAAO,CAAC;YAAE,IAAI,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;KACrC;;CAgBF,CAAC"}
|
package/dist/routes/llms.js
CHANGED
|
@@ -7,6 +7,7 @@ import { findSmartNotFoundSuggestions, renderSmartNotFoundMarkdown, } from "../i
|
|
|
7
7
|
import { isPageVisibleForSurface } from "../page-visibility.js";
|
|
8
8
|
const INDEX_MARKDOWN_PATTERN = /\/index\.md$/;
|
|
9
9
|
const MARKDOWN_PATTERN = /\.md$/;
|
|
10
|
+
const MARKDOWN_CACHE_CONTROL = "public, max-age=0, s-maxage=86400, stale-while-revalidate=604800";
|
|
10
11
|
const resolveSources = (source, sources, caller) => {
|
|
11
12
|
const resolvedSources = sources ?? (source ? [source] : []);
|
|
12
13
|
if (resolvedSources.length === 0) {
|
|
@@ -158,7 +159,10 @@ export const createLlmsRoute = ({ filterPage, source, sources, transform, }) =>
|
|
|
158
159
|
};
|
|
159
160
|
export const createDocsMarkdownRoute = ({ config, filterStaticParams, notFound: notFoundOptions = {}, source, sources, transform, }) => {
|
|
160
161
|
const routeSources = resolveSources(source, sources, "createDocsMarkdownRoute");
|
|
161
|
-
const routingConfig =
|
|
162
|
+
const routingConfig = {
|
|
163
|
+
...(routeSources[0].routingConfig ?? {}),
|
|
164
|
+
...config,
|
|
165
|
+
};
|
|
162
166
|
const smartNotFoundOptions = notFoundOptions === false ? {} : notFoundOptions;
|
|
163
167
|
const supportedLanguages = new Set([
|
|
164
168
|
routingConfig.defaultLanguage ?? "en",
|
|
@@ -292,7 +296,13 @@ export const createDocsMarkdownRoute = ({ config, filterStaticParams, notFound:
|
|
|
292
296
|
const rendered = await pageSource.getPageMarkdown(page);
|
|
293
297
|
const pageData = page.data;
|
|
294
298
|
const canonicalPath = withBasePath(pageData.canonical ?? page.url, routingConfig.basePath);
|
|
295
|
-
const
|
|
299
|
+
const canonicalUrl = routingConfig.siteUrl
|
|
300
|
+
? new URL(canonicalPath, routingConfig.siteUrl)
|
|
301
|
+
: new URL(canonicalPath, request.url);
|
|
302
|
+
const headers = applyMarkdownHeaders(new Headers({
|
|
303
|
+
"Cache-Control": MARKDOWN_CACHE_CONTROL,
|
|
304
|
+
"Content-Type": "text/markdown",
|
|
305
|
+
}), { canonicalUrl });
|
|
296
306
|
return new Response(transform
|
|
297
307
|
? await transform(rendered, { lang, page, source: pageSource })
|
|
298
308
|
: rendered, {
|
package/dist/source.d.ts
CHANGED
|
@@ -33,12 +33,16 @@ export interface GeistdocsMarkdownContext {
|
|
|
33
33
|
url: string;
|
|
34
34
|
};
|
|
35
35
|
}
|
|
36
|
+
export type GeistdocsMarkdownFrontmatterValue = boolean | Date | number | readonly string[] | string | null | undefined;
|
|
37
|
+
export type GeistdocsMarkdownFrontmatter = Record<string, GeistdocsMarkdownFrontmatterValue>;
|
|
36
38
|
export interface GeistdocsMarkdownOptions {
|
|
39
|
+
/** Add or override fields in the generated Markdown frontmatter. */
|
|
40
|
+
frontmatter?: (defaults: Readonly<GeistdocsMarkdownFrontmatter>, context: GeistdocsMarkdownContext) => GeistdocsMarkdownFrontmatter | Promise<GeistdocsMarkdownFrontmatter>;
|
|
37
41
|
transform?: (markdown: string, context: GeistdocsMarkdownContext) => Promise<string> | string;
|
|
38
42
|
}
|
|
39
43
|
export interface CreateSourceOptions {
|
|
40
44
|
baseUrl?: string;
|
|
41
|
-
config: Pick<GeistdocsConfig, "agent" | "basePath" | "defaultLanguage" | "translations"> & Partial<Pick<GeistdocsConfig, "title">>;
|
|
45
|
+
config: Pick<GeistdocsConfig, "agent" | "basePath" | "defaultLanguage" | "siteUrl" | "translations"> & Partial<Pick<GeistdocsConfig, "title">>;
|
|
42
46
|
docs: FumadocsCollection;
|
|
43
47
|
id?: string;
|
|
44
48
|
label?: string;
|
|
@@ -68,6 +72,7 @@ export declare const createSource: ({ docs, config, baseUrl, id, label, markdown
|
|
|
68
72
|
agent: import("./config.js").GeistdocsAgentReadinessConfig | undefined;
|
|
69
73
|
basePath: string | undefined;
|
|
70
74
|
defaultLanguage: string | undefined;
|
|
75
|
+
siteUrl: string | undefined;
|
|
71
76
|
title: string | undefined;
|
|
72
77
|
translations: import("./config.js").GeistdocsTranslations | undefined;
|
|
73
78
|
};
|
|
@@ -101,6 +106,7 @@ export declare const createSources: ({ config, sources }: CreateSourcesOptions)
|
|
|
101
106
|
agent: import("./config.js").GeistdocsAgentReadinessConfig | undefined;
|
|
102
107
|
basePath: string | undefined;
|
|
103
108
|
defaultLanguage: string | undefined;
|
|
109
|
+
siteUrl: string | undefined;
|
|
104
110
|
title: string | undefined;
|
|
105
111
|
translations: import("./config.js").GeistdocsTranslations | undefined;
|
|
106
112
|
};
|
|
@@ -138,6 +144,7 @@ export declare const createVersionedSources: ({ config, current, versions, }: Cr
|
|
|
138
144
|
agent: import("./config.js").GeistdocsAgentReadinessConfig | undefined;
|
|
139
145
|
basePath: string | undefined;
|
|
140
146
|
defaultLanguage: string | undefined;
|
|
147
|
+
siteUrl: string | undefined;
|
|
141
148
|
title: string | undefined;
|
|
142
149
|
translations: import("./config.js").GeistdocsTranslations | undefined;
|
|
143
150
|
};
|
|
@@ -166,6 +173,7 @@ export declare const createVersionedSources: ({ config, current, versions, }: Cr
|
|
|
166
173
|
agent: import("./config.js").GeistdocsAgentReadinessConfig | undefined;
|
|
167
174
|
basePath: string | undefined;
|
|
168
175
|
defaultLanguage: string | undefined;
|
|
176
|
+
siteUrl: string | undefined;
|
|
169
177
|
title: string | undefined;
|
|
170
178
|
translations: import("./config.js").GeistdocsTranslations | undefined;
|
|
171
179
|
};
|
|
@@ -193,6 +201,7 @@ export declare const createVersionedSources: ({ config, current, versions, }: Cr
|
|
|
193
201
|
agent: import("./config.js").GeistdocsAgentReadinessConfig | undefined;
|
|
194
202
|
basePath: string | undefined;
|
|
195
203
|
defaultLanguage: string | undefined;
|
|
204
|
+
siteUrl: string | undefined;
|
|
196
205
|
title: string | undefined;
|
|
197
206
|
translations: import("./config.js").GeistdocsTranslations | undefined;
|
|
198
207
|
};
|
package/dist/source.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"source.d.ts","sourceRoot":"","sources":["../src/source.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,aAAa,EAClB,MAAM,EAEP,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,oBAAoB,EAG1B,MAAM,aAAa,CAAC;
|
|
1
|
+
{"version":3,"file":"source.d.ts","sourceRoot":"","sources":["../src/source.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,aAAa,EAClB,MAAM,EAEP,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,oBAAoB,EAG1B,MAAM,aAAa,CAAC;AAErB,OAAO,EACL,KAAK,qBAAqB,EAE3B,MAAM,6BAA6B,CAAC;AAErC,YAAY,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAEzE,KAAK,aAAa,GAAG,UAAU,CAAC,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;AA0FlD,MAAM,WAAW,kBAAkB;IACjC,gBAAgB,IAAI,aAAa,CAAC,QAAQ,CAAC,CAAC;CAC7C;AAED,MAAM,WAAW,uBAAuB;IACtC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACrC,OAAO,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC5C,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,YAAY,CAAC,EAAE,IAAI,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE;QACJ,IAAI,EAAE,uBAAuB,CAAC;QAC9B,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,EAAE,CAAC;QAChB,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;CACH;AAED,MAAM,MAAM,iCAAiC,GACzC,OAAO,GACP,IAAI,GACJ,MAAM,GACN,SAAS,MAAM,EAAE,GACjB,MAAM,GACN,IAAI,GACJ,SAAS,CAAC;AAEd,MAAM,MAAM,4BAA4B,GAAG,MAAM,CAC/C,MAAM,EACN,iCAAiC,CAClC,CAAC;AAEF,MAAM,WAAW,wBAAwB;IACvC,oEAAoE;IACpE,WAAW,CAAC,EAAE,CACZ,QAAQ,EAAE,QAAQ,CAAC,4BAA4B,CAAC,EAChD,OAAO,EAAE,wBAAwB,KAC9B,4BAA4B,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;IAC1E,SAAS,CAAC,EAAE,CACV,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,wBAAwB,KAC9B,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;CAC/B;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,IAAI,CACV,eAAe,EACf,OAAO,GAAG,UAAU,GAAG,iBAAiB,GAAG,SAAS,GAAG,cAAc,CACtE,GACC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC;IAC1C,IAAI,EAAE,kBAAkB,CAAC;IACzB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,wBAAwB,CAAC;CACrC;AAED,MAAM,WAAW,yBACf,SAAQ,IAAI,CAAC,mBAAmB,EAAE,QAAQ,CAAC;IAC3C,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,kCACf,SAAQ,yBAAyB;IACjC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IACtC,OAAO,EAAE,yBAAyB,EAAE,CAAC;CACtC;AAED,MAAM,WAAW,6BAA6B;IAC5C,MAAM,EAAE,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IACtC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,kCAAkC,EAAE,CAAC;CAChD;AA4FD,eAAO,MAAM,YAAY,GAAI,iDAO1B,mBAAmB;;;;;;;;;;;;;;;;yBAiBQ,aAAa;;;OAAe;;;;4BASnB,aAAa;;;OAAe;CAyGlE,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC;AAEpE,eAAO,MAAM,uBAAuB,GAClC,QAAQ,OAAO,KACd,MAAM,IAAI,qBAKC,CAAC;AAEf,eAAO,MAAM,aAAa,GAAI,qBAAqB,oBAAoB;;;;;;;;;;;;;;;;;;;;iCA/HzC,aAAa;;;eAAe;;;;oCASnB,aAAa;;;eAAe;;;UA0I1D,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC;CAE7C,CAAC;AAEF,eAAO,MAAM,sBAAsB,GAAI,gCAIpC,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;iCA3JF,aAAa;;;eAAe;;;;oCASnB,aAAa;;;eAAe;;;;;;;;;;;;;;;;;;;6BATrC,aAAa;;;WAAe;;;;gCASnB,aAAa;;;WAAe;;;;;;;;;;;;;;;;;;6BATrC,aAAa;;;WAAe;;;;gCASnB,aAAa;;;WAAe;;;CAqLlE,CAAC;AAEF,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE;QAAE,IAAI,EAAE;YAAE,KAAK,EAAE,MAAM,EAAE,CAAC;YAAC,GAAG,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,KAAK,MAAM,CAAC;IAC7E,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,6EAA6E;IAC7E,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,qBAAqB,GAAG,qBAAqB,EAAE,CAAC;CAC1D;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB,GAAI,6CAKjC,0BAA0B,KAAG,MAAM,EAYrC,CAAC;AAEF,MAAM,WAAW,gCAAgC;IAC/C,UAAU,CAAC,EAAE,0BAA0B,CAAC,YAAY,CAAC,CAAC;IACtD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,OAAO,sBAAsB,CAAC,EAAE,KAAK,CAAC,CAAC;CAClE;AAED;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,GAAI,iCAIvC,gCAAgC,KAAG,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAiBvE,CAAC"}
|
package/dist/source.js
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { defineI18n } from "fumadocs-core/i18n";
|
|
2
2
|
import { loader, } from "fumadocs-core/source";
|
|
3
3
|
import { getPublicPath, withBasePath, } from "./config.js";
|
|
4
|
+
import { mdxToMarkdown } from "./internal/mdx-to-markdown.js";
|
|
4
5
|
import { stripVersionRoutePrefix, } from "./internal/version-paths.js";
|
|
5
6
|
const MARKDOWN_LINK_PATTERN = /(\]\()(\/(?!\/)[^)\s]*)/g;
|
|
6
7
|
const ROOT_ATTRIBUTE_PATTERN = /(\b(?:href|src)=["'])(\/(?!\/)[^"']*)/g;
|
|
@@ -64,6 +65,40 @@ const getLanguages = (config) => {
|
|
|
64
65
|
languages: Array.from(new Set([defaultLanguage, ...languages])),
|
|
65
66
|
};
|
|
66
67
|
};
|
|
68
|
+
const YAML_NEEDS_QUOTING = /[:#{}[\]&*!|>'"%@`]/;
|
|
69
|
+
const ALWAYS_QUOTED_FRONTMATTER = new Set(["badge", "navTitle"]);
|
|
70
|
+
const formatFrontmatterValue = (value, forceQuotes = false) => {
|
|
71
|
+
if (value instanceof Date) {
|
|
72
|
+
return value.toISOString().slice(0, 10);
|
|
73
|
+
}
|
|
74
|
+
if (typeof value === "string") {
|
|
75
|
+
return forceQuotes ||
|
|
76
|
+
YAML_NEEDS_QUOTING.test(value) ||
|
|
77
|
+
value.trim() !== value
|
|
78
|
+
? JSON.stringify(value)
|
|
79
|
+
: value;
|
|
80
|
+
}
|
|
81
|
+
return String(value);
|
|
82
|
+
};
|
|
83
|
+
const formatFrontmatter = (fields) => {
|
|
84
|
+
const lines = ["---"];
|
|
85
|
+
const isStringArray = (value) => Array.isArray(value);
|
|
86
|
+
for (const [key, value] of Object.entries(fields)) {
|
|
87
|
+
if (value == null || value === false) {
|
|
88
|
+
continue;
|
|
89
|
+
}
|
|
90
|
+
if (isStringArray(value)) {
|
|
91
|
+
if (value.length === 0) {
|
|
92
|
+
continue;
|
|
93
|
+
}
|
|
94
|
+
lines.push(`${key}:`, ...value.map((entry) => ` - ${formatFrontmatterValue(entry)}`));
|
|
95
|
+
continue;
|
|
96
|
+
}
|
|
97
|
+
lines.push(`${key}: ${formatFrontmatterValue(value, ALWAYS_QUOTED_FRONTMATTER.has(key))}`);
|
|
98
|
+
}
|
|
99
|
+
lines.push("---");
|
|
100
|
+
return lines.join("\n");
|
|
101
|
+
};
|
|
67
102
|
const pageTreeTransformer = {
|
|
68
103
|
file(node, filePath) {
|
|
69
104
|
if (!filePath) {
|
|
@@ -107,51 +142,56 @@ export const createSource = ({ docs, config, baseUrl = "/docs", id, label, markd
|
|
|
107
142
|
};
|
|
108
143
|
const getPageMarkdown = async (page) => {
|
|
109
144
|
const data = page.data;
|
|
110
|
-
const
|
|
111
|
-
const { title, description, badge, product, type, summary, prerequisites, related, navTitle, internal, noindex, canonical, tags, keywords, excludeFrom, } = data;
|
|
112
|
-
const frontmatter = [
|
|
113
|
-
"---",
|
|
114
|
-
`title: ${title}`,
|
|
115
|
-
description && `description: ${description}`,
|
|
116
|
-
badge && `badge: ${JSON.stringify(badge)}`,
|
|
117
|
-
product && `product: ${product}`,
|
|
118
|
-
navTitle && `navTitle: ${JSON.stringify(navTitle)}`,
|
|
119
|
-
type && `type: ${type}`,
|
|
120
|
-
summary && `summary: ${summary}`,
|
|
121
|
-
internal && "internal: true",
|
|
122
|
-
noindex && "noindex: true",
|
|
123
|
-
canonical && `canonical: ${canonical}`,
|
|
124
|
-
tags?.length && `tags:\n${tags.map((tag) => ` - ${tag}`).join("\n")}`,
|
|
125
|
-
keywords?.length &&
|
|
126
|
-
`keywords:\n${keywords.map((keyword) => ` - ${keyword}`).join("\n")}`,
|
|
127
|
-
excludeFrom?.length &&
|
|
128
|
-
`excludeFrom:\n${excludeFrom.map((surface) => ` - ${surface}`).join("\n")}`,
|
|
129
|
-
prerequisites?.length &&
|
|
130
|
-
`prerequisites:\n${prerequisites
|
|
131
|
-
.map((prerequisite) => ` - ${prerequisite}`)
|
|
132
|
-
.join("\n")}`,
|
|
133
|
-
related?.length &&
|
|
134
|
-
`related:\n${related
|
|
135
|
-
.map((entry) => ` - ${entry}`)
|
|
136
|
-
.join("\n")}`,
|
|
137
|
-
"---",
|
|
138
|
-
]
|
|
139
|
-
.filter(Boolean)
|
|
140
|
-
.join("\n");
|
|
145
|
+
const content = await mdxToMarkdown(await data.getText("processed"));
|
|
146
|
+
const { title, description, badge, product, type, summary, prerequisites, related, navTitle, internal, noindex, canonical, tags, keywords, excludeFrom, lastModified, } = data;
|
|
141
147
|
const sitemapPath = "/sitemap.md";
|
|
142
148
|
const llmsPath = "/llms.txt";
|
|
143
149
|
const agentsPath = "/agents.md";
|
|
144
150
|
const sitemapLabel = getPublicPath(sitemapPath, config.basePath);
|
|
145
151
|
const llmsLabel = getPublicPath(llmsPath, config.basePath);
|
|
146
152
|
const agentsLabel = getPublicPath(agentsPath, config.basePath);
|
|
153
|
+
const pagePath = canonical
|
|
154
|
+
? withBasePath(canonical, config.basePath)
|
|
155
|
+
: getPublicPath(page.url, config.basePath);
|
|
156
|
+
const defaults = {
|
|
157
|
+
title,
|
|
158
|
+
description,
|
|
159
|
+
url: config.siteUrl
|
|
160
|
+
? new URL(pagePath, config.siteUrl).toString()
|
|
161
|
+
: undefined,
|
|
162
|
+
docs_index: llmsLabel,
|
|
163
|
+
lastUpdated: lastModified,
|
|
164
|
+
badge,
|
|
165
|
+
product,
|
|
166
|
+
navTitle,
|
|
167
|
+
type,
|
|
168
|
+
summary,
|
|
169
|
+
internal,
|
|
170
|
+
noindex,
|
|
171
|
+
canonical,
|
|
172
|
+
tags,
|
|
173
|
+
keywords,
|
|
174
|
+
excludeFrom,
|
|
175
|
+
prerequisites,
|
|
176
|
+
related,
|
|
177
|
+
};
|
|
178
|
+
const context = {
|
|
179
|
+
page: page,
|
|
180
|
+
};
|
|
181
|
+
const overrides = markdown?.frontmatter
|
|
182
|
+
? await markdown.frontmatter(defaults, context)
|
|
183
|
+
: {};
|
|
184
|
+
const fields = { ...defaults, ...overrides };
|
|
185
|
+
const frontmatter = formatFrontmatter(fields);
|
|
186
|
+
const docsIndex = typeof fields.docs_index === "string" ? fields.docs_index : llmsLabel;
|
|
147
187
|
const agentDiscoveryLink = config.agent && config.agent.enabled !== false
|
|
148
188
|
? `\n\nFor agent-facing discovery, including API and MCP surfaces, see [${agentsLabel}](${agentsPath})`
|
|
149
189
|
: "";
|
|
150
190
|
const rendered = `${frontmatter}
|
|
151
191
|
|
|
152
|
-
|
|
192
|
+
> For an index of all documentation, see [${docsIndex}](${docsIndex}).
|
|
153
193
|
|
|
154
|
-
${
|
|
194
|
+
${content}
|
|
155
195
|
|
|
156
196
|
---
|
|
157
197
|
|
|
@@ -160,7 +200,7 @@ For a semantic overview of all documentation, see [${sitemapLabel}](${sitemapPat
|
|
|
160
200
|
For an index of all available documentation, see [${llmsLabel}](${llmsPath})${agentDiscoveryLink}`;
|
|
161
201
|
const transformed = markdown?.transform
|
|
162
202
|
? await markdown.transform(rendered, {
|
|
163
|
-
|
|
203
|
+
...context,
|
|
164
204
|
})
|
|
165
205
|
: rendered;
|
|
166
206
|
return prefixMarkdownLinks(transformed, config.basePath);
|
|
@@ -171,6 +211,7 @@ For an index of all available documentation, see [${llmsLabel}](${llmsPath})${ag
|
|
|
171
211
|
agent: config.agent,
|
|
172
212
|
basePath: config.basePath,
|
|
173
213
|
defaultLanguage: config.defaultLanguage,
|
|
214
|
+
siteUrl: config.siteUrl,
|
|
174
215
|
title: config.title,
|
|
175
216
|
translations: config.translations,
|
|
176
217
|
},
|
package/dist/versions.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use client";
|
|
2
2
|
import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
|
|
3
3
|
import { cn } from "@vercel/geistcn/utils";
|
|
4
|
-
import { IconArchive, IconBox, IconCheck,
|
|
4
|
+
import { IconArchive, IconBox, IconCheck, IconChevronUpDown, } from "@vercel/geistcn-assets/icons";
|
|
5
5
|
import { usePathname, useRouter } from "next/navigation";
|
|
6
6
|
import { DropdownMenu, DropdownMenuContent, DropdownMenuItem, DropdownMenuTrigger, } from "./internal/ui/dropdown-menu";
|
|
7
7
|
import { resolveVersionSwitchPath, } from "./internal/version-paths.js";
|
|
@@ -73,7 +73,7 @@ export const GeistdocsRouteSelect = ({ ariaLabel = "Select route", className, cu
|
|
|
73
73
|
const currentDescription = currentItem
|
|
74
74
|
? getDescription({ active: true, item: currentItem })
|
|
75
75
|
: null;
|
|
76
|
-
return (_jsxs(DropdownMenu, { children: [_jsx(DropdownMenuTrigger, { asChild: true, children: _jsxs("button", { "aria-label": ariaLabel, className: cn("group flex w-full items-center gap-2 rounded-md px-2 py-2 text-left outline-none transition-colors duration-150 ease-[cubic-bezier(0.175,0.885,0.32,1.1)] hover:bg-gray-alpha-100 focus-visible:shadow-[var(--ds-focus-ring)] active:bg-gray-alpha-300 data-[state=open]:bg-gray-alpha-100 motion-reduce:transition-none", className), type: "button", children: [currentItem ? renderIcon({ active: true, item: currentItem }) : null, _jsxs("span", { className: "min-w-0 flex-1", children: [_jsx("span", { className: "block truncate text-button-14 text-gray-1000", children: currentItem?.label ?? currentId }), currentDescription ? (_jsx("span", { className: "block truncate text-gray-900 text-label-13", children: currentDescription })) : null] }), _jsx(
|
|
76
|
+
return (_jsxs(DropdownMenu, { children: [_jsx(DropdownMenuTrigger, { asChild: true, children: _jsxs("button", { "aria-label": ariaLabel, className: cn("group flex w-full items-center gap-2 rounded-md px-2 py-2 text-left outline-none transition-colors duration-150 ease-[cubic-bezier(0.175,0.885,0.32,1.1)] hover:bg-gray-alpha-100 focus-visible:shadow-[var(--ds-focus-ring)] active:bg-gray-alpha-300 data-[state=open]:bg-gray-alpha-100 motion-reduce:transition-none", className), type: "button", children: [currentItem ? renderIcon({ active: true, item: currentItem }) : null, _jsxs("span", { className: "min-w-0 flex-1", children: [_jsx("span", { className: "block truncate text-button-14 text-gray-1000", children: currentItem?.label ?? currentId }), currentDescription ? (_jsx("span", { className: "block truncate text-gray-900 text-label-13", children: currentDescription })) : null] }), _jsx(IconChevronUpDown, { className: "size-4 shrink-0 text-gray-900" })] }) }), _jsx(DropdownMenuContent, { align: "start", className: "w-(--radix-dropdown-menu-trigger-width) min-w-64 rounded-xl bg-background-100 p-1 shadow-(--ds-shadow-menu)", children: items.map((item) => {
|
|
77
77
|
const active = item.id === currentId;
|
|
78
78
|
const description = getDescription({ active, item });
|
|
79
79
|
return (_jsxs(DropdownMenuItem, { "aria-current": active ? "page" : undefined, className: "flex cursor-pointer items-center gap-2 rounded-md px-2 py-2", onSelect: () => navigateToItem(item), children: [renderIcon({ active, item }), _jsxs("span", { className: "min-w-0 flex-1", children: [_jsx("span", { className: "block truncate text-button-14 text-gray-1000", children: item.label }), description ? (_jsx("span", { className: "block truncate text-gray-900 text-label-13", children: description })) : null] }), active ? _jsx(IconCheck, { className: "size-4 text-blue-900" }) : null] }, item.id));
|
package/docs/agents.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Geistdocs Package Docs
|
|
2
2
|
|
|
3
|
-
These docs are bundled with `@vercel/geistdocs` 1.25.1-canary.
|
|
3
|
+
These docs are bundled with `@vercel/geistdocs` 1.25.1-canary.d2f4449 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
|
|
@@ -25,8 +25,9 @@ They are generated from `apps/template/content/docs` during the package build.
|
|
|
25
25
|
- [Overview](pages/index.md): Geistdocs is a packaged documentation system for creating Next.js and Fumadocs sites with shared runtime features.
|
|
26
26
|
- [Getting Started](pages/getting-started.md): Create a Geistdocs project, run it locally, and edit your first documentation page.
|
|
27
27
|
- [Environment Variables](pages/env.md): Environment variables required by Geistdocs for AI chat, proxy mode, and production URL configuration.
|
|
28
|
-
- [Deploy to Vercel](pages/deployment.md): Deploy
|
|
29
|
-
- [
|
|
28
|
+
- [Deploy to Vercel](pages/deployment.md): Deploy a Geistdocs site to Vercel with the required project settings, environment variables, and private-package access.
|
|
29
|
+
- [Migrate to Geistdocs](pages/migration.md): Move an existing documentation site to @vercel/geistdocs while keeping local content, routing, middleware behavior, and AI-readable surfaces intact.
|
|
30
|
+
- [Migrate from Geistdocs 1.x to 2.0](pages/migration-2.md): A concise, agent-friendly checklist for upgrading an existing Geistdocs 1.x site to 2.0.
|
|
30
31
|
- [Configuration](pages/configuration.md): Configure site metadata, navigation, AI features, page actions, translations, and local adapters.
|
|
31
32
|
- [Syntax](pages/syntax.md): Supported MDX syntax including text formatting, code blocks, line highlighting, and Mermaid diagrams.
|
|
32
33
|
- [Geistdocs Provider](pages/provider.md): The root provider component that wraps your application to handle toast notifications, search, and analytics.
|