@vercel/geistdocs 1.12.0 → 1.14.0
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/config.d.ts +5 -0
- package/dist/config.d.ts.map +1 -1
- package/dist/config.js +35 -0
- package/dist/controls.d.ts.map +1 -1
- package/dist/controls.js +7 -5
- package/dist/footer.d.ts +1 -1
- package/dist/footer.d.ts.map +1 -1
- package/dist/footer.js +1 -1
- package/dist/home-layout.d.ts.map +1 -1
- package/dist/home-layout.js +2 -7
- package/dist/internal/chat/shell.d.ts.map +1 -1
- package/dist/internal/chat/shell.js +2 -1
- package/dist/internal/footer/rss-button.d.ts +3 -1
- package/dist/internal/footer/rss-button.d.ts.map +1 -1
- package/dist/internal/footer/rss-button.js +2 -1
- package/dist/internal/localized-link.d.ts.map +1 -1
- package/dist/internal/localized-link.js +9 -4
- package/dist/internal/page-actions-client.d.ts +1 -0
- package/dist/internal/page-actions-client.d.ts.map +1 -1
- package/dist/internal/page-actions-client.js +2 -4
- package/dist/internal/provider-client.d.ts.map +1 -1
- package/dist/internal/provider-client.js +1 -1
- package/dist/internal/search.d.ts.map +1 -1
- package/dist/internal/search.js +2 -1
- package/dist/internal/sidebar-responsive.d.ts +3 -0
- package/dist/internal/sidebar-responsive.d.ts.map +1 -0
- package/dist/internal/sidebar-responsive.js +10 -0
- package/dist/internal/sidebar-tree.d.ts +23 -0
- package/dist/internal/sidebar-tree.d.ts.map +1 -0
- package/dist/internal/sidebar-tree.js +115 -0
- package/dist/internal/sidebar.d.ts +2 -5
- package/dist/internal/sidebar.d.ts.map +1 -1
- package/dist/internal/sidebar.js +282 -44
- package/dist/internal/table-of-contents.js +1 -1
- package/dist/internal/ui/sheet.d.ts.map +1 -1
- package/dist/internal/ui/sheet.js +2 -2
- package/dist/internal/version-paths.d.ts +49 -0
- package/dist/internal/version-paths.d.ts.map +1 -0
- package/dist/internal/version-paths.js +57 -0
- package/dist/layout.d.ts.map +1 -1
- package/dist/layout.js +1 -6
- package/dist/mdx.d.ts +1 -0
- package/dist/mdx.d.ts.map +1 -1
- package/dist/mobile-docs-bar.d.ts.map +1 -1
- package/dist/mobile-docs-bar.js +3 -3
- package/dist/navbar.js +1 -1
- package/dist/pages/docs.d.ts +25 -7
- package/dist/pages/docs.d.ts.map +1 -1
- package/dist/pages/docs.js +40 -8
- package/dist/proxy.d.ts +4 -3
- package/dist/proxy.d.ts.map +1 -1
- package/dist/proxy.js +124 -46
- package/dist/routes/agents.d.ts +1 -1
- package/dist/routes/agents.d.ts.map +1 -1
- package/dist/routes/agents.js +27 -16
- package/dist/routes/chat.d.ts +1 -1
- package/dist/routes/chat.d.ts.map +1 -1
- package/dist/routes/chat.js +18 -11
- package/dist/routes/discovery.d.ts +6 -2
- package/dist/routes/discovery.d.ts.map +1 -1
- package/dist/routes/discovery.js +6 -12
- package/dist/routes/sitemap.d.ts +3 -2
- package/dist/routes/sitemap.d.ts.map +1 -1
- package/dist/routes/sitemap.js +18 -5
- package/dist/source-config.d.ts +1 -0
- package/dist/source-config.d.ts.map +1 -1
- package/dist/source-config.js +1 -0
- package/dist/source.d.ts +40 -2
- package/dist/source.d.ts.map +1 -1
- package/dist/source.js +132 -15
- package/dist/versions.d.ts +22 -2
- package/dist/versions.d.ts.map +1 -1
- package/dist/versions.js +29 -6
- package/docs/agents.md +2 -2
- package/docs/llms.txt +313 -31
- package/docs/manifest.json +10 -9
- package/docs/pages/configuration.md +26 -1
- package/docs/pages/getting-started.md +2 -0
- package/docs/pages/guides/nested-navigation.md +174 -13
- package/docs/pages/md.md +4 -0
- package/docs/pages/migration.md +4 -0
- package/docs/pages/proxy.md +15 -0
- package/docs/pages/rss.md +2 -0
- package/docs/pages/syntax.md +2 -1
- package/docs/pages/versioned-docs.md +68 -0
- package/docs/sitemap.md +1 -1
- package/package.json +1 -1
- package/source-config.js +1 -0
- package/template/AGENTS.md +2 -0
- package/template/app/[lang]/rss.xml/route.ts +7 -3
- package/template/app/styles/geistdocs.css +8 -6
- package/template/content/docs/configuration.mdx +26 -1
- package/template/content/docs/getting-started.mdx +2 -0
- package/template/content/docs/guides/nested-navigation.mdx +174 -12
- package/template/content/docs/md.mdx +4 -0
- package/template/content/docs/migration.mdx +4 -0
- package/template/content/docs/proxy.mdx +15 -0
- package/template/content/docs/rss.mdx +2 -0
- package/template/content/docs/syntax.mdx +2 -1
- package/template/content/docs/versioned-docs.mdx +68 -0
- package/template/package.json +1 -1
- package/theme.css +150 -0
package/dist/pages/docs.d.ts
CHANGED
|
@@ -2,7 +2,7 @@ import { DocsPage as FumadocsDocsPage } from "fumadocs-ui/layouts/docs/page";
|
|
|
2
2
|
import type { MDXComponents } from "mdx/types";
|
|
3
3
|
import type { Metadata } from "next";
|
|
4
4
|
import type { ComponentProps, ComponentType, ReactNode } from "react";
|
|
5
|
-
import type
|
|
5
|
+
import { type GeistdocsConfig } from "../config";
|
|
6
6
|
import { type GeistdocsPageVisibilityData } from "../internal/page-visibility";
|
|
7
7
|
import type { GeistdocsSourceBundle } from "../source";
|
|
8
8
|
type SourceBundle = GeistdocsSourceBundle;
|
|
@@ -23,6 +23,23 @@ type OpenGraphImages = NonNullable<Metadata["openGraph"]>["images"];
|
|
|
23
23
|
interface DocsPageOpenGraphOptions {
|
|
24
24
|
images?: boolean | OpenGraphImages;
|
|
25
25
|
}
|
|
26
|
+
interface PageUrlContext {
|
|
27
|
+
page: GeistdocsPage;
|
|
28
|
+
params: DocsPageParams;
|
|
29
|
+
}
|
|
30
|
+
interface PublicPageUrlContext extends PageUrlContext {
|
|
31
|
+
pageUrl: string;
|
|
32
|
+
}
|
|
33
|
+
interface MarkdownUrlContext extends PublicPageUrlContext {
|
|
34
|
+
publicPageUrl: string;
|
|
35
|
+
}
|
|
36
|
+
export interface ResolvePageMarkdownUrlOptions {
|
|
37
|
+
basePath?: string;
|
|
38
|
+
isRootMountedPage?: boolean;
|
|
39
|
+
pageUrl: string;
|
|
40
|
+
publicPageUrl?: string;
|
|
41
|
+
}
|
|
42
|
+
export declare const resolvePageMarkdownUrl: ({ basePath, pageUrl, isRootMountedPage, publicPageUrl, }: ResolvePageMarkdownUrlOptions) => string;
|
|
26
43
|
interface DocsPageData extends GeistdocsPageVisibilityData {
|
|
27
44
|
body: ComponentType<{
|
|
28
45
|
components?: MDXComponents;
|
|
@@ -33,12 +50,11 @@ interface DocsPageData extends GeistdocsPageVisibilityData {
|
|
|
33
50
|
toc: ComponentProps<typeof FumadocsDocsPage>["toc"];
|
|
34
51
|
}
|
|
35
52
|
interface CreateDocsPageOptions {
|
|
36
|
-
config: Pick<GeistdocsConfig, "ai" | "feedback" | "github" | "pageActions" | "siteId">;
|
|
53
|
+
config: Pick<GeistdocsConfig, "ai" | "basePath" | "feedback" | "github" | "pageActions" | "siteId">;
|
|
37
54
|
filterStaticParams?: (params: DocsPageParams) => boolean;
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
}) => string;
|
|
55
|
+
getMarkdownUrl?: (context: MarkdownUrlContext) => string;
|
|
56
|
+
getPageUrl?: (context: PageUrlContext) => string;
|
|
57
|
+
getPublicPageUrl?: (context: PublicPageUrlContext) => string;
|
|
42
58
|
mdx?: DocsPageMdx;
|
|
43
59
|
metadata?: (context: {
|
|
44
60
|
metadata: Metadata;
|
|
@@ -50,8 +66,10 @@ interface CreateDocsPageOptions {
|
|
|
50
66
|
renderTop?: (context: {
|
|
51
67
|
data: DocsPageData;
|
|
52
68
|
markdown: string;
|
|
69
|
+
markdownUrl: string;
|
|
53
70
|
page: GeistdocsPage;
|
|
54
71
|
pageUrl: string;
|
|
72
|
+
publicPageUrl: string;
|
|
55
73
|
}) => ReactNode;
|
|
56
74
|
resolveLink?: (context: {
|
|
57
75
|
link: DocsPageLink;
|
|
@@ -62,7 +80,7 @@ interface CreateDocsPageOptions {
|
|
|
62
80
|
tableOfContent?: TableOfContentOptions;
|
|
63
81
|
tableOfContentPopover?: ComponentProps<typeof FumadocsDocsPage>["tableOfContentPopover"];
|
|
64
82
|
}
|
|
65
|
-
export declare const createDocsPage: ({ config, source, mdx, pageActions, filterStaticParams, getPageUrl, metadata, openGraph, renderTop, resolveLink, tableOfContent, tableOfContentPopover, }: CreateDocsPageOptions) => {
|
|
83
|
+
export declare const createDocsPage: ({ config, source, mdx, pageActions, filterStaticParams, getMarkdownUrl, getPageUrl, getPublicPageUrl, metadata, openGraph, renderTop, resolveLink, tableOfContent, tableOfContentPopover, }: CreateDocsPageOptions) => {
|
|
66
84
|
Page: ({ params, }: {
|
|
67
85
|
params: Promise<{
|
|
68
86
|
lang: string;
|
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":"AAAA,OAAO,EAGL,QAAQ,IAAI,gBAAgB,EAE7B,MAAM,+BAA+B,CAAC;AAEvC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAErC,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AACtE,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"docs.d.ts","sourceRoot":"","sources":["../../src/pages/docs.tsx"],"names":[],"mappings":"AAAA,OAAO,EAGL,QAAQ,IAAI,gBAAgB,EAE7B,MAAM,+BAA+B,CAAC;AAEvC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAErC,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AACtE,OAAO,EAAE,KAAK,eAAe,EAA+B,MAAM,WAAW,CAAC;AAS9E,OAAO,EACL,KAAK,2BAA2B,EAEjC,MAAM,6BAA6B,CAAC;AAGrC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAEvD,KAAK,YAAY,GAAG,qBAAqB,CAAC;AAE1C,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,UAAU,cAAc;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,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;AAED,UAAU,cAAc;IACtB,IAAI,EAAE,aAAa,CAAC;IACpB,MAAM,EAAE,cAAc,CAAC;CACxB;AAED,UAAU,oBAAqB,SAAQ,cAAc;IACnD,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,UAAU,kBAAmB,SAAQ,oBAAoB;IACvD,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,GAAI,0DAKpC,6BAA6B,WAW/B,CAAC;AAEF,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,UAAU,qBAAqB;IAC7B,MAAM,EAAE,IAAI,CACV,eAAe,EACf,IAAI,GAAG,UAAU,GAAG,UAAU,GAAG,QAAQ,GAAG,aAAa,GAAG,QAAQ,CACrE,CAAC;IACF,kBAAkB,CAAC,EAAE,CAAC,MAAM,EAAE,cAAc,KAAK,OAAO,CAAC;IACzD,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,kBAAkB,KAAK,MAAM,CAAC;IACzD,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,MAAM,CAAC;IACjD,gBAAgB,CAAC,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,MAAM,CAAC;IAC7D,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,cAAc,CAAC;KACxB,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,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;AA+BD,eAAO,MAAM,cAAc,GAAI,6LAe5B,qBAAqB;wBAoBnB;QACD,MAAM,EAAE,OAAO,CAAC;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;SAAE,CAAC,CAAC;KACpD;;oCA4JE;QACD,MAAM,EAAE,OAAO,CAAC;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;SAAE,CAAC,CAAC;KACpD,KAAG,OAAO,CAAC,QAAQ,CAAC;CA6CtB,CAAC;AAEF,eAAO,MAAM,iBAAiB;;;CAA4B,CAAC"}
|
package/dist/pages/docs.js
CHANGED
|
@@ -2,6 +2,7 @@ import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-run
|
|
|
2
2
|
import { DocsBody as FumadocsDocsBody, DocsDescription as FumadocsDocsDescription, DocsPage as FumadocsDocsPage, DocsTitle as FumadocsDocsTitle, } from "fumadocs-ui/layouts/docs/page";
|
|
3
3
|
import { createRelativeLink } from "fumadocs-ui/mdx";
|
|
4
4
|
import { notFound } from "next/navigation";
|
|
5
|
+
import { getPublicPath, withBasePath } from "../config";
|
|
5
6
|
import { cn } from "../internal/cn";
|
|
6
7
|
import { createPageActions as createInternalPageActions } from "../internal/page-actions";
|
|
7
8
|
import { GeistdocsPageActions, GeistdocsTableOfContentsActions, } from "../internal/page-actions-client";
|
|
@@ -10,13 +11,34 @@ import { getPageFooterItems, PageFooter } from "../internal/page-footer";
|
|
|
10
11
|
import { getPageRobots, } from "../internal/page-visibility";
|
|
11
12
|
import { GeistdocsTableOfContents } from "../internal/table-of-contents";
|
|
12
13
|
import { createMdxComponents } from "../mdx";
|
|
14
|
+
const TRAILING_SLASH_PATTERN = /\/$/;
|
|
15
|
+
export const resolvePageMarkdownUrl = ({ basePath, pageUrl, isRootMountedPage = pageUrl === "/", publicPageUrl = getPublicPath(pageUrl, basePath), }) => {
|
|
16
|
+
const normalizedPublicPageUrl = publicPageUrl.replace(TRAILING_SLASH_PATTERN, "");
|
|
17
|
+
if (isRootMountedPage) {
|
|
18
|
+
return `${normalizedPublicPageUrl}/index.md`;
|
|
19
|
+
}
|
|
20
|
+
return `${normalizedPublicPageUrl}.md`;
|
|
21
|
+
};
|
|
13
22
|
const DocsTitle = ({ className, ...props }) => (_jsx(FumadocsDocsTitle, { className: cn("mb-4 text-balance text-4xl tracking-tight", className), ...props }));
|
|
14
23
|
const DocsDescription = (props) => _jsx(FumadocsDocsDescription, { ...props });
|
|
15
24
|
const DocsBody = ({ className, ...props }) => (_jsx(FumadocsDocsBody, { className: cn("mx-auto w-full", className), ...props }));
|
|
16
25
|
const hasTableOfContentsActions = (config, extraActions) => config.pageActions?.scrollTop !== false ||
|
|
17
26
|
config.feedback?.enabled !== false ||
|
|
18
27
|
extraActions.length > 0;
|
|
19
|
-
export const createDocsPage = ({ config, source, mdx, pageActions = createInternalPageActions({ config }), filterStaticParams, getPageUrl, metadata, openGraph, renderTop, resolveLink, tableOfContent, tableOfContentPopover, }) => {
|
|
28
|
+
export const createDocsPage = ({ config, source, mdx, pageActions = createInternalPageActions({ config }), filterStaticParams, getMarkdownUrl, getPageUrl, getPublicPageUrl, metadata, openGraph, renderTop, resolveLink, tableOfContent, tableOfContentPopover, }) => {
|
|
29
|
+
const resolvePageUrls = (page, params) => {
|
|
30
|
+
const pageUrl = getPageUrl?.({ page, params }) ?? page.url;
|
|
31
|
+
const publicPageUrl = getPublicPageUrl?.({ page, params, pageUrl }) ??
|
|
32
|
+
getPublicPath(pageUrl, config.basePath);
|
|
33
|
+
const markdownUrl = getMarkdownUrl?.({ page, params, pageUrl, publicPageUrl }) ??
|
|
34
|
+
resolvePageMarkdownUrl({
|
|
35
|
+
basePath: config.basePath,
|
|
36
|
+
isRootMountedPage: source.baseUrl === "/" && page.slugs.length === 0,
|
|
37
|
+
pageUrl,
|
|
38
|
+
publicPageUrl,
|
|
39
|
+
});
|
|
40
|
+
return { markdownUrl, pageUrl, publicPageUrl };
|
|
41
|
+
};
|
|
20
42
|
const Page = async ({ params, }) => {
|
|
21
43
|
const resolvedParams = await params;
|
|
22
44
|
const { slug, lang } = resolvedParams;
|
|
@@ -31,7 +53,7 @@ export const createDocsPage = ({ config, source, mdx, pageActions = createIntern
|
|
|
31
53
|
? resolveLink({ link: defaultLink, page, source })
|
|
32
54
|
: defaultLink;
|
|
33
55
|
const resolvedMdx = typeof mdx === "function" ? mdx({ link, page, source }) : mdx;
|
|
34
|
-
const pageUrl =
|
|
56
|
+
const { markdownUrl, pageUrl, publicPageUrl } = resolvePageUrls(page, resolvedParams);
|
|
35
57
|
const footerItems = getPageFooterItems(source.source.getPageTree(lang), page.url);
|
|
36
58
|
const pagesByUrl = getPageUrl
|
|
37
59
|
? new Map(source.source.getPages(lang).map((entry) => [entry.url, entry]))
|
|
@@ -64,7 +86,7 @@ export const createDocsPage = ({ config, source, mdx, pageActions = createIntern
|
|
|
64
86
|
markdown,
|
|
65
87
|
page: {
|
|
66
88
|
path: page.path,
|
|
67
|
-
url:
|
|
89
|
+
url: publicPageUrl,
|
|
68
90
|
},
|
|
69
91
|
}) ?? [])
|
|
70
92
|
: [];
|
|
@@ -78,9 +100,17 @@ export const createDocsPage = ({ config, source, mdx, pageActions = createIntern
|
|
|
78
100
|
single: true,
|
|
79
101
|
...tableOfContent,
|
|
80
102
|
component: tocComponent,
|
|
81
|
-
}, tableOfContentPopover: tableOfContentPopover, toc: data.toc, children: [renderTop?.({
|
|
103
|
+
}, tableOfContentPopover: tableOfContentPopover, toc: data.toc, children: [renderTop?.({
|
|
104
|
+
data,
|
|
105
|
+
markdown: markdown ?? "",
|
|
106
|
+
markdownUrl,
|
|
107
|
+
page,
|
|
108
|
+
pageUrl,
|
|
109
|
+
publicPageUrl,
|
|
110
|
+
}), _jsxs("div", { className: "flex flex-col-reverse gap-4 sm:flex-row sm:items-end sm:justify-between", children: [_jsx(DocsTitle, { className: "mb-0 min-w-0", children: data.title }), _jsx(GeistdocsPageActions, { config: pageActions.config, page: {
|
|
111
|
+
markdownUrl,
|
|
82
112
|
path: page.path,
|
|
83
|
-
url:
|
|
113
|
+
url: publicPageUrl,
|
|
84
114
|
} })] }), _jsx(DocsDescription, { children: data.description }), _jsx(DocsBody, { children: _jsx(MDX, { components: {
|
|
85
115
|
...createMdxComponents({ a: link }),
|
|
86
116
|
...resolvedMdx,
|
|
@@ -98,7 +128,7 @@ export const createDocsPage = ({ config, source, mdx, pageActions = createIntern
|
|
|
98
128
|
notFound();
|
|
99
129
|
}
|
|
100
130
|
const data = page.data;
|
|
101
|
-
const
|
|
131
|
+
const { markdownUrl } = resolvePageUrls(page, resolvedParams);
|
|
102
132
|
const openGraphImages = openGraph?.images === true
|
|
103
133
|
? source.getPageImage(page).url
|
|
104
134
|
: openGraph?.images;
|
|
@@ -109,9 +139,11 @@ export const createDocsPage = ({ config, source, mdx, pageActions = createIntern
|
|
|
109
139
|
robots: getPageRobots(page),
|
|
110
140
|
...(openGraphImages ? { openGraph: { images: openGraphImages } } : {}),
|
|
111
141
|
alternates: {
|
|
112
|
-
canonical: data.canonical
|
|
142
|
+
canonical: data.canonical
|
|
143
|
+
? withBasePath(data.canonical, config.basePath)
|
|
144
|
+
: undefined,
|
|
113
145
|
types: {
|
|
114
|
-
"text/markdown":
|
|
146
|
+
"text/markdown": markdownUrl,
|
|
115
147
|
},
|
|
116
148
|
},
|
|
117
149
|
};
|
package/dist/proxy.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { type NextFetchEvent, type NextRequest } from "next/server";
|
|
2
|
-
import type
|
|
2
|
+
import { type GeistdocsConfig } from "./config";
|
|
3
3
|
export type DetectionMethod = "ua-match" | "signature-agent" | "heuristic" | null;
|
|
4
4
|
export interface TrackMarkdownRequestEvent {
|
|
5
5
|
acceptHeader: string | null;
|
|
@@ -21,6 +21,7 @@ export interface GeistdocsMarkdownRoute {
|
|
|
21
21
|
from: `/${string}`;
|
|
22
22
|
to: `/${string}` | ((context: {
|
|
23
23
|
defaultLanguage: string;
|
|
24
|
+
language: string;
|
|
24
25
|
path: string[];
|
|
25
26
|
pathname: string;
|
|
26
27
|
}) => `/${string}`);
|
|
@@ -28,10 +29,10 @@ export interface GeistdocsMarkdownRoute {
|
|
|
28
29
|
export interface CreateProxyOptions {
|
|
29
30
|
after?: GeistdocsProxyHook | GeistdocsProxyHook[];
|
|
30
31
|
before?: GeistdocsProxyHook | GeistdocsProxyHook[];
|
|
31
|
-
config: Pick<GeistdocsConfig, "content" | "defaultLanguage" | "translations">;
|
|
32
|
+
config: Pick<GeistdocsConfig, "basePath" | "content" | "defaultLanguage" | "translations">;
|
|
32
33
|
markdownRoutes?: GeistdocsMarkdownRoute[];
|
|
33
34
|
trackMarkdownRequest?: (event: TrackMarkdownRequestEvent) => Promise<void> | void;
|
|
34
35
|
}
|
|
35
|
-
export declare const createProxy: ({ after, before, config, markdownRoutes, trackMarkdownRequest, }: CreateProxyOptions) => (request: NextRequest, context: NextFetchEvent) => Promise<
|
|
36
|
+
export declare const createProxy: ({ after, before, config, markdownRoutes, trackMarkdownRequest, }: CreateProxyOptions) => (request: NextRequest, context: NextFetchEvent) => Promise<Response>;
|
|
36
37
|
export {};
|
|
37
38
|
//# sourceMappingURL=proxy.d.ts.map
|
package/dist/proxy.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"proxy.d.ts","sourceRoot":"","sources":["../src/proxy.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,WAAW,EAEjB,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"proxy.d.ts","sourceRoot":"","sources":["../src/proxy.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,WAAW,EAEjB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,KAAK,eAAe,EAGrB,MAAM,UAAU,CAAC;AAElB,MAAM,MAAM,eAAe,GACvB,UAAU,GACV,iBAAiB,GACjB,WAAW,GACX,IAAI,CAAC;AAET,MAAM,WAAW,yBAAyB;IACxC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,WAAW,CAAC,EAAE,QAAQ,GAAG,mBAAmB,GAAG,eAAe,CAAC;IAC/D,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,cAAc,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,OAAO,EAAE,WAAW,CAAC;CACtB;AAED,KAAK,eAAe,GAAG,QAAQ,GAAG,SAAS,GAAG,IAAI,CAAC;AAEnD,MAAM,MAAM,kBAAkB,GAAG,CAC/B,OAAO,EAAE,qBAAqB,KAC3B,OAAO,CAAC,eAAe,CAAC,GAAG,eAAe,CAAC;AAEhD,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,IAAI,MAAM,EAAE,CAAC;IACnB,EAAE,EACE,IAAI,MAAM,EAAE,GACZ,CAAC,CAAC,OAAO,EAAE;QACT,eAAe,EAAE,MAAM,CAAC;QACxB,QAAQ,EAAE,MAAM,CAAC;QACjB,IAAI,EAAE,MAAM,EAAE,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;KAClB,KAAK,IAAI,MAAM,EAAE,CAAC,CAAC;CACzB;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,CAAC,EAAE,kBAAkB,GAAG,kBAAkB,EAAE,CAAC;IAClD,MAAM,CAAC,EAAE,kBAAkB,GAAG,kBAAkB,EAAE,CAAC;IACnD,MAAM,EAAE,IAAI,CACV,eAAe,EACf,UAAU,GAAG,SAAS,GAAG,iBAAiB,GAAG,cAAc,CAC5D,CAAC;IACF,cAAc,CAAC,EAAE,sBAAsB,EAAE,CAAC;IAC1C,oBAAoB,CAAC,EAAE,CACrB,KAAK,EAAE,yBAAyB,KAC7B,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;CAC3B;AA8JD,eAAO,MAAM,WAAW,GAAI,kEAMzB,kBAAkB,MAsOL,SAAS,WAAW,EAAE,SAAS,cAAc,sBA6C5D,CAAC"}
|
package/dist/proxy.js
CHANGED
|
@@ -3,6 +3,7 @@ import { defineI18n } from "fumadocs-core/i18n";
|
|
|
3
3
|
import { createI18nMiddleware } from "fumadocs-core/i18n/middleware";
|
|
4
4
|
import { isMarkdownPreferred } from "fumadocs-core/negotiation";
|
|
5
5
|
import { NextResponse, } from "next/server";
|
|
6
|
+
import { getPublicPath, normalizeBasePath, } from "./config";
|
|
6
7
|
const MDX_EXTENSION_PATTERN = /\.mdx?$/;
|
|
7
8
|
const PATH_TOKEN_PATTERN = /\*path|:path\*/g;
|
|
8
9
|
const PATH_WILDCARD_PATTERN = /\/\*path$/;
|
|
@@ -10,6 +11,13 @@ const DEFAULT_MARKDOWN_ROUTE = {
|
|
|
10
11
|
from: "/docs/*path",
|
|
11
12
|
to: "/[lang]/llms.mdx/*path",
|
|
12
13
|
};
|
|
14
|
+
const PACKAGE_ROUTE_PATHS = new Set([
|
|
15
|
+
"/.well-known/mcp.json",
|
|
16
|
+
"/agents.md",
|
|
17
|
+
"/llms.txt",
|
|
18
|
+
"/rss.xml",
|
|
19
|
+
"/sitemap.md",
|
|
20
|
+
]);
|
|
13
21
|
const TRAILING_SLASH_PATTERN = /\/$/;
|
|
14
22
|
const getLanguages = (config) => {
|
|
15
23
|
const defaultLanguage = config.defaultLanguage ?? "en";
|
|
@@ -58,6 +66,52 @@ const runHooks = async (hooks, proxyContext) => {
|
|
|
58
66
|
}
|
|
59
67
|
return null;
|
|
60
68
|
};
|
|
69
|
+
const getRoutePath = (route, pathname) => {
|
|
70
|
+
const hasWildcard = PATH_WILDCARD_PATTERN.test(route.from);
|
|
71
|
+
const routeBasePath = route.from.replace(PATH_WILDCARD_PATTERN, "");
|
|
72
|
+
const matches = hasWildcard
|
|
73
|
+
? pathname === routeBasePath || pathname.startsWith(`${routeBasePath}/`)
|
|
74
|
+
: pathname === route.from;
|
|
75
|
+
if (!matches) {
|
|
76
|
+
return null;
|
|
77
|
+
}
|
|
78
|
+
if (!(hasWildcard && pathname !== routeBasePath)) {
|
|
79
|
+
return [];
|
|
80
|
+
}
|
|
81
|
+
const path = pathname
|
|
82
|
+
.slice(routeBasePath.length + 1)
|
|
83
|
+
.split("/")
|
|
84
|
+
.filter(Boolean);
|
|
85
|
+
if (routeBasePath === "" && path.length === 1 && path[0] === "index") {
|
|
86
|
+
return [];
|
|
87
|
+
}
|
|
88
|
+
return path;
|
|
89
|
+
};
|
|
90
|
+
const addBasePathToRedirect = (response, request, basePath) => {
|
|
91
|
+
const location = response.headers.get("location");
|
|
92
|
+
if (!location) {
|
|
93
|
+
return;
|
|
94
|
+
}
|
|
95
|
+
const target = new URL(location, request.url);
|
|
96
|
+
if (target.pathname === basePath ||
|
|
97
|
+
target.pathname.startsWith(`${basePath}/`)) {
|
|
98
|
+
return;
|
|
99
|
+
}
|
|
100
|
+
target.pathname = getPublicPath(target.pathname, basePath);
|
|
101
|
+
response.headers.set("location", target.toString());
|
|
102
|
+
};
|
|
103
|
+
const getLocalizedPathname = (pathname, languages, defaultLanguage) => {
|
|
104
|
+
const segments = pathname.split("/").filter(Boolean);
|
|
105
|
+
const language = segments[0];
|
|
106
|
+
if (!(language && languages.includes(language))) {
|
|
107
|
+
return { hasLanguagePrefix: false, language: defaultLanguage, pathname };
|
|
108
|
+
}
|
|
109
|
+
return {
|
|
110
|
+
hasLanguagePrefix: true,
|
|
111
|
+
language,
|
|
112
|
+
pathname: `/${segments.slice(1).join("/")}`,
|
|
113
|
+
};
|
|
114
|
+
};
|
|
61
115
|
export const createProxy = ({ after, before, config, markdownRoutes, trackMarkdownRequest, }) => {
|
|
62
116
|
const routeMappings = markdownRoutes ??
|
|
63
117
|
inferMarkdownRoutes(config) ?? [DEFAULT_MARKDOWN_ROUTE];
|
|
@@ -67,7 +121,11 @@ export const createProxy = ({ after, before, config, markdownRoutes, trackMarkdo
|
|
|
67
121
|
languages,
|
|
68
122
|
hideLocale: "default-locale",
|
|
69
123
|
});
|
|
70
|
-
const
|
|
124
|
+
const configuredBasePath = normalizeBasePath(config.basePath);
|
|
125
|
+
const internationalizer = createI18nMiddleware({
|
|
126
|
+
...i18n,
|
|
127
|
+
format: (locale, path) => getPublicPath(`/${locale}${path}`, configuredBasePath),
|
|
128
|
+
});
|
|
71
129
|
const beforeHooks = normalizeHooks(before);
|
|
72
130
|
const afterHooks = normalizeHooks(after);
|
|
73
131
|
const trackRequest = (context, event) => {
|
|
@@ -76,66 +134,62 @@ export const createProxy = ({ after, before, config, markdownRoutes, trackMarkdo
|
|
|
76
134
|
}
|
|
77
135
|
context.waitUntil(Promise.resolve(trackMarkdownRequest(event)));
|
|
78
136
|
};
|
|
79
|
-
const resolveMarkdownRewrite = (pathname) => {
|
|
137
|
+
const resolveMarkdownRewrite = (pathname, language) => {
|
|
80
138
|
for (const route of routeMappings) {
|
|
81
|
-
const
|
|
82
|
-
|
|
83
|
-
const matches = hasWildcard
|
|
84
|
-
? pathname === basePath || pathname.startsWith(`${basePath}/`)
|
|
85
|
-
: pathname === route.from;
|
|
86
|
-
if (!matches) {
|
|
139
|
+
const path = getRoutePath(route, pathname);
|
|
140
|
+
if (!path) {
|
|
87
141
|
continue;
|
|
88
142
|
}
|
|
89
|
-
const path = hasWildcard && pathname !== basePath
|
|
90
|
-
? pathname
|
|
91
|
-
.slice(basePath.length + 1)
|
|
92
|
-
.split("/")
|
|
93
|
-
.filter(Boolean)
|
|
94
|
-
: [];
|
|
95
143
|
if (typeof route.to === "function") {
|
|
96
|
-
return route.to({ defaultLanguage, path, pathname });
|
|
144
|
+
return route.to({ defaultLanguage, language, path, pathname });
|
|
97
145
|
}
|
|
98
|
-
const destination = route.to.replace("[lang]",
|
|
146
|
+
const destination = route.to.replace("[lang]", language);
|
|
99
147
|
const pathValue = path.join("/");
|
|
100
148
|
const rewritten = destination.replace(PATH_TOKEN_PATTERN, pathValue);
|
|
101
149
|
return rewritten.endsWith("/") ? rewritten.slice(0, -1) : rewritten;
|
|
102
150
|
}
|
|
103
151
|
return null;
|
|
104
152
|
};
|
|
105
|
-
const tryMarkdownRewrite = (request, context, pathname, options) => {
|
|
106
|
-
const result = resolveMarkdownRewrite(pathname);
|
|
153
|
+
const tryMarkdownRewrite = (request, context, pathname, language, options) => {
|
|
154
|
+
const result = resolveMarkdownRewrite(pathname, language);
|
|
107
155
|
if (!result) {
|
|
108
156
|
return null;
|
|
109
157
|
}
|
|
110
158
|
trackRequest(context, {
|
|
111
|
-
path: options?.trackPath ?? pathname,
|
|
159
|
+
path: getPublicPath(options?.trackPath ?? pathname, config.basePath),
|
|
112
160
|
userAgent: request.headers.get("user-agent"),
|
|
113
161
|
referer: request.headers.get("referer"),
|
|
114
162
|
acceptHeader: request.headers.get("accept"),
|
|
115
163
|
requestType: options?.requestType,
|
|
116
164
|
detectionMethod: options?.detectionMethod,
|
|
117
165
|
});
|
|
118
|
-
|
|
166
|
+
const rewriteUrl = request.nextUrl.clone();
|
|
167
|
+
if (configuredBasePath) {
|
|
168
|
+
rewriteUrl.basePath = configuredBasePath;
|
|
169
|
+
}
|
|
170
|
+
rewriteUrl.pathname = result;
|
|
171
|
+
return NextResponse.rewrite(rewriteUrl);
|
|
119
172
|
};
|
|
120
|
-
const isMdExtensionRequest = (pathname) => (pathname.endsWith(".md") || pathname.endsWith(".mdx")) &&
|
|
121
|
-
Boolean(resolveMarkdownRewrite(pathname.replace(MDX_EXTENSION_PATTERN, "")));
|
|
122
|
-
const handleMarkdownExtensionRequest = (request, context, pathname) => {
|
|
123
|
-
if (!isMdExtensionRequest(pathname)) {
|
|
173
|
+
const isMdExtensionRequest = (pathname, language) => (pathname.endsWith(".md") || pathname.endsWith(".mdx")) &&
|
|
174
|
+
Boolean(resolveMarkdownRewrite(pathname.replace(MDX_EXTENSION_PATTERN, ""), language));
|
|
175
|
+
const handleMarkdownExtensionRequest = (request, context, pathname, language, trackPath) => {
|
|
176
|
+
if (!isMdExtensionRequest(pathname, language)) {
|
|
124
177
|
return null;
|
|
125
178
|
}
|
|
126
|
-
return tryMarkdownRewrite(request, context, pathname.replace(MDX_EXTENSION_PATTERN, ""), {
|
|
179
|
+
return tryMarkdownRewrite(request, context, pathname.replace(MDX_EXTENSION_PATTERN, ""), language, {
|
|
127
180
|
requestType: "md-url",
|
|
128
|
-
trackPath
|
|
181
|
+
trackPath,
|
|
129
182
|
});
|
|
130
183
|
};
|
|
131
|
-
const handleAgentRewrite = (request, context, pathname) => {
|
|
184
|
+
const handleAgentRewrite = (request, context, pathname, language, trackPath) => {
|
|
132
185
|
const agentResult = isAIAgent(request);
|
|
133
186
|
if (!agentResult.detected || isMarkdownPreferred(request)) {
|
|
134
187
|
return null;
|
|
135
188
|
}
|
|
136
|
-
const response = tryMarkdownRewrite(request, context, pathname, {
|
|
189
|
+
const response = tryMarkdownRewrite(request, context, pathname, language, {
|
|
137
190
|
requestType: "agent-rewrite",
|
|
138
191
|
detectionMethod: agentResult.method,
|
|
192
|
+
trackPath,
|
|
139
193
|
});
|
|
140
194
|
if (response) {
|
|
141
195
|
return response;
|
|
@@ -144,11 +198,41 @@ export const createProxy = ({ after, before, config, markdownRoutes, trackMarkdo
|
|
|
144
198
|
headers: { "Content-Type": "text/markdown; charset=utf-8" },
|
|
145
199
|
});
|
|
146
200
|
};
|
|
147
|
-
const handlePreferredMarkdownRequest = (request, context) => isMarkdownPreferred(request)
|
|
148
|
-
? tryMarkdownRewrite(request, context,
|
|
201
|
+
const handlePreferredMarkdownRequest = (request, context, pathname, language, trackPath) => isMarkdownPreferred(request)
|
|
202
|
+
? tryMarkdownRewrite(request, context, pathname, language, {
|
|
149
203
|
requestType: "header-negotiated",
|
|
204
|
+
trackPath,
|
|
150
205
|
})
|
|
151
206
|
: null;
|
|
207
|
+
const handleMarkdownNegotiation = (request, context, pathname) => {
|
|
208
|
+
const localized = getLocalizedPathname(pathname, languages, defaultLanguage);
|
|
209
|
+
if ((localized.hasLanguagePrefix && localized.language === defaultLanguage) ||
|
|
210
|
+
PACKAGE_ROUTE_PATHS.has(localized.pathname)) {
|
|
211
|
+
return null;
|
|
212
|
+
}
|
|
213
|
+
const extensionResponse = handleMarkdownExtensionRequest(request, context, localized.pathname, localized.language, pathname);
|
|
214
|
+
if (extensionResponse) {
|
|
215
|
+
return extensionResponse;
|
|
216
|
+
}
|
|
217
|
+
if (resolveMarkdownRewrite(localized.pathname, localized.language) &&
|
|
218
|
+
!localized.pathname.includes("/llms.mdx/")) {
|
|
219
|
+
const agentResponse = handleAgentRewrite(request, context, localized.pathname, localized.language, pathname);
|
|
220
|
+
if (agentResponse) {
|
|
221
|
+
return agentResponse;
|
|
222
|
+
}
|
|
223
|
+
}
|
|
224
|
+
return handlePreferredMarkdownRequest(request, context, localized.pathname, localized.language, pathname);
|
|
225
|
+
};
|
|
226
|
+
const handleI18nRequest = async (request, context) => {
|
|
227
|
+
const response = await internationalizer(request, context);
|
|
228
|
+
if (!response) {
|
|
229
|
+
return NextResponse.next();
|
|
230
|
+
}
|
|
231
|
+
if (configuredBasePath) {
|
|
232
|
+
addBasePathToRedirect(response, request, configuredBasePath);
|
|
233
|
+
}
|
|
234
|
+
return response;
|
|
235
|
+
};
|
|
152
236
|
return async (request, context) => {
|
|
153
237
|
const pathname = request.nextUrl.pathname;
|
|
154
238
|
const proxyContext = {
|
|
@@ -161,29 +245,23 @@ export const createProxy = ({ after, before, config, markdownRoutes, trackMarkdo
|
|
|
161
245
|
if (beforeResponse) {
|
|
162
246
|
return beforeResponse;
|
|
163
247
|
}
|
|
164
|
-
|
|
248
|
+
const localized = getLocalizedPathname(pathname, languages, defaultLanguage);
|
|
249
|
+
if (localized.pathname === "/llms.txt") {
|
|
165
250
|
trackRequest(context, {
|
|
166
|
-
path:
|
|
251
|
+
path: getPublicPath(pathname, config.basePath),
|
|
167
252
|
userAgent: request.headers.get("user-agent"),
|
|
168
253
|
referer: request.headers.get("referer"),
|
|
169
254
|
acceptHeader: request.headers.get("accept"),
|
|
170
255
|
});
|
|
171
256
|
}
|
|
172
|
-
const
|
|
173
|
-
if (
|
|
174
|
-
return
|
|
175
|
-
}
|
|
176
|
-
if (resolveMarkdownRewrite(pathname) && !pathname.includes("/llms.mdx/")) {
|
|
177
|
-
const response = handleAgentRewrite(request, context, pathname);
|
|
178
|
-
if (response) {
|
|
179
|
-
return response;
|
|
180
|
-
}
|
|
181
|
-
}
|
|
182
|
-
const preferredMarkdownResponse = handlePreferredMarkdownRequest(request, context);
|
|
183
|
-
if (preferredMarkdownResponse) {
|
|
184
|
-
return preferredMarkdownResponse;
|
|
257
|
+
const markdownResponse = handleMarkdownNegotiation(request, context, pathname);
|
|
258
|
+
if (markdownResponse) {
|
|
259
|
+
return markdownResponse;
|
|
185
260
|
}
|
|
186
261
|
const afterResponse = await runHooks(afterHooks, proxyContext);
|
|
187
|
-
|
|
262
|
+
if (afterResponse) {
|
|
263
|
+
return afterResponse;
|
|
264
|
+
}
|
|
265
|
+
return handleI18nRequest(request, context);
|
|
188
266
|
};
|
|
189
267
|
};
|
package/dist/routes/agents.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { NextRequest } from "next/server";
|
|
2
|
-
import type
|
|
2
|
+
import { type GeistdocsConfig } from "../config";
|
|
3
3
|
export interface CreateAgentsRouteOptions {
|
|
4
4
|
config: Pick<GeistdocsConfig, "agent" | "basePath" | "content" | "defaultLanguage" | "github" | "nav" | "title" | "translations" | "versions">;
|
|
5
5
|
transform?: (markdown: string, context: {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"agents.d.ts","sourceRoot":"","sources":["../../src/routes/agents.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"agents.d.ts","sourceRoot":"","sources":["../../src/routes/agents.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EACL,KAAK,eAAe,EAGrB,MAAM,WAAW,CAAC;AAQnB,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,IAAI,CACV,eAAe,EACb,OAAO,GACP,UAAU,GACV,SAAS,GACT,iBAAiB,GACjB,QAAQ,GACR,KAAK,GACL,OAAO,GACP,cAAc,GACd,UAAU,CACb,CAAC;IACF,SAAS,CAAC,EAAE,CACV,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,WAAW,CAAA;KAAE,KAC7C,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;CAC/B;AAuRD,eAAO,MAAM,iBAAiB,GAAI,wBAG/B,wBAAwB;mBAId,WAAW,eACR;QAAE,MAAM,CAAC,EAAE,OAAO,CAAC;YAAE,IAAI,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC,CAAA;KAAE;;;;;CA2BtD,CAAC"}
|
package/dist/routes/agents.js
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
1
|
+
import { getPublicPath, } from "../config";
|
|
2
|
+
import { getDiscoveryLanguages, toPublicUrl, toSiteUrl, validateAgentDiscoveryConfig, } from "./discovery";
|
|
3
|
+
const getDefaultAgentInstructions = (config) => [
|
|
4
|
+
`Use ${getPublicPath("/sitemap.md", config.basePath)} to identify the most relevant documentation pages before answering broad questions.`,
|
|
5
|
+
`Use ${getPublicPath("/llms.txt", config.basePath)} when you need the complete documentation corpus as Markdown context.`,
|
|
5
6
|
"Fetch individual documentation pages with a .md or .mdx extension for focused page-level context.",
|
|
6
7
|
"Do not assume API, authentication, OpenAPI, or MCP support unless it is listed in this file.",
|
|
7
8
|
];
|
|
@@ -14,7 +15,7 @@ const renderList = (items) => items.map((item) => `- ${item}`).join("\n");
|
|
|
14
15
|
const getDocsLinks = (config, origin) => {
|
|
15
16
|
const contentLinks = (config.content ?? []).map((section) => ({
|
|
16
17
|
label: section.label,
|
|
17
|
-
href:
|
|
18
|
+
href: toPublicUrl({
|
|
18
19
|
basePath: config.basePath,
|
|
19
20
|
href: section.route,
|
|
20
21
|
origin,
|
|
@@ -27,22 +28,22 @@ const getDocsLinks = (config, origin) => {
|
|
|
27
28
|
return [
|
|
28
29
|
{
|
|
29
30
|
label: "Documentation",
|
|
30
|
-
href:
|
|
31
|
+
href: toPublicUrl({ basePath: config.basePath, href: "/docs", origin }),
|
|
31
32
|
description: "Primary human-readable documentation",
|
|
32
33
|
},
|
|
33
34
|
];
|
|
34
35
|
};
|
|
35
36
|
const getNavigationLinks = (nav, config, origin) => (nav ?? []).map((item) => ({
|
|
36
37
|
label: item.label,
|
|
37
|
-
href:
|
|
38
|
+
href: toPublicUrl({ basePath: config.basePath, href: item.href, origin }),
|
|
38
39
|
description: item.external ? "External navigation link" : undefined,
|
|
39
40
|
}));
|
|
40
41
|
const renderDocumentationSection = (config, origin) => [
|
|
41
42
|
"## Documentation Surfaces",
|
|
42
43
|
"",
|
|
43
44
|
...getDocsLinks(config, origin).map((link) => renderLink(link.label, link.href, link.description)),
|
|
44
|
-
renderLink("Full documentation context",
|
|
45
|
-
renderLink("Semantic documentation sitemap",
|
|
45
|
+
renderLink("Full documentation context", toPublicUrl({ basePath: config.basePath, href: "/llms.txt", origin }), "All configured documentation as Markdown"),
|
|
46
|
+
renderLink("Semantic documentation sitemap", toPublicUrl({ basePath: config.basePath, href: "/sitemap.md", origin }), "High-level documentation map for agent navigation"),
|
|
46
47
|
"- Page-level Markdown: append .md or .mdx to a documentation URL",
|
|
47
48
|
"",
|
|
48
49
|
];
|
|
@@ -85,7 +86,11 @@ const renderMcpSection = (mcp, config, origin) => {
|
|
|
85
86
|
? toSiteUrl(config, origin, mcp.manifestUrl)
|
|
86
87
|
: undefined;
|
|
87
88
|
const generatedManifestUrl = mcp?.servers?.length
|
|
88
|
-
?
|
|
89
|
+
? toPublicUrl({
|
|
90
|
+
basePath: config.basePath,
|
|
91
|
+
href: "/.well-known/mcp.json",
|
|
92
|
+
origin,
|
|
93
|
+
})
|
|
89
94
|
: undefined;
|
|
90
95
|
const links = [
|
|
91
96
|
manifestUrl && renderLink("MCP manifest", manifestUrl),
|
|
@@ -130,17 +135,23 @@ const renderVersionsSection = (config, origin) => {
|
|
|
130
135
|
...config.versions.items.map((version) => {
|
|
131
136
|
const marker = version.id === config.versions?.current ? " current" : "";
|
|
132
137
|
const href = version.href ?? version.routePrefix;
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
138
|
+
if (!href) {
|
|
139
|
+
return `- ${version.label}${marker}${version.description ? `: ${version.description}` : ""}`;
|
|
140
|
+
}
|
|
141
|
+
const url = version.href
|
|
142
|
+
? toSiteUrl(config, origin, href)
|
|
143
|
+
: toPublicUrl({ basePath: config.basePath, href, origin });
|
|
144
|
+
return renderLink(`${version.label}${marker}`, url, version.description);
|
|
136
145
|
}),
|
|
137
146
|
"",
|
|
138
147
|
];
|
|
139
148
|
};
|
|
140
|
-
const renderInstructionsSection = (agent) => [
|
|
149
|
+
const renderInstructionsSection = (agent, config) => [
|
|
141
150
|
"## Agent Instructions",
|
|
142
151
|
"",
|
|
143
|
-
renderList(agent.instructions?.length
|
|
152
|
+
renderList(agent.instructions?.length
|
|
153
|
+
? agent.instructions
|
|
154
|
+
: getDefaultAgentInstructions(config)),
|
|
144
155
|
"",
|
|
145
156
|
];
|
|
146
157
|
const renderAgentsMarkdown = (config, request) => {
|
|
@@ -160,7 +171,7 @@ const renderAgentsMarkdown = (config, request) => {
|
|
|
160
171
|
...renderMcpSection(agent.mcp, config, origin),
|
|
161
172
|
...renderImportantLinksSection(agent, config, origin),
|
|
162
173
|
...renderVersionsSection(config, origin),
|
|
163
|
-
...renderInstructionsSection(agent),
|
|
174
|
+
...renderInstructionsSection(agent, config),
|
|
164
175
|
].join("\n");
|
|
165
176
|
};
|
|
166
177
|
export const createAgentsRoute = ({ config, transform, }) => {
|
package/dist/routes/chat.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { type LanguageModel } from "ai";
|
|
2
|
-
import type
|
|
2
|
+
import { type GeistdocsConfig } from "../config";
|
|
3
3
|
import type { GeistdocsSourceBundle } from "../source";
|
|
4
4
|
type SourceBundle = GeistdocsSourceBundle;
|
|
5
5
|
interface ChatProxyConfig {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"chat.d.ts","sourceRoot":"","sources":["../../src/routes/chat.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,KAAK,aAAa,EAQnB,MAAM,IAAI,CAAC;AAGZ,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"chat.d.ts","sourceRoot":"","sources":["../../src/routes/chat.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,KAAK,aAAa,EAQnB,MAAM,IAAI,CAAC;AAGZ,OAAO,EAAE,KAAK,eAAe,EAAiB,MAAM,WAAW,CAAC;AAEhE,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,sBAAsB;IAC9B,MAAM,EAAE,IAAI,CACV,eAAe,EACf,IAAI,GAAG,UAAU,GAAG,iBAAiB,GAAG,cAAc,CACvD,CAAC;IACF;;;;;OAKG;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;AAqrBD,eAAO,MAAM,eAAe,GAAI,4CAM7B,sBAAsB;gBAIE,OAAO;;CA0IjC,CAAC"}
|