@vercel/geistdocs 1.25.1-canary.c58830e → 1.25.1-canary.fdff126
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.js +1 -1
- 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/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/table.d.ts +3 -0
- package/dist/components/table.d.ts.map +1 -0
- package/dist/components/table.js +3 -0
- package/dist/controls.js +1 -1
- package/dist/internal/page-actions-client.d.ts.map +1 -1
- package/dist/internal/page-actions-client.js +33 -12
- package/dist/internal/provider-client.js +1 -1
- package/dist/internal/search.d.ts.map +1 -1
- package/dist/internal/search.js +1 -1
- package/dist/internal/sidebar.d.ts.map +1 -1
- package/dist/internal/sidebar.js +21 -17
- package/dist/internal/table-of-contents.d.ts.map +1 -1
- package/dist/internal/table-of-contents.js +1 -1
- package/dist/internal/ui/dropdown-menu.js +6 -6
- 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 +10 -1
- package/dist/pages/docs.d.ts.map +1 -1
- package/dist/pages/docs.js +1 -1
- package/dist/versions.js +2 -2
- package/docs/agents.md +1 -1
- package/docs/llms.txt +78 -6
- package/docs/manifest.json +1 -1
- package/docs/pages/syntax.md +77 -5
- package/package.json +1 -1
- package/template/app/[lang]/layout.tsx +4 -0
- package/template/app/styles/geistdocs.css +1 -1
- package/template/content/docs/syntax.mdx +82 -5
- package/template/package.json +1 -1
- package/theme.css +39 -101
|
@@ -10,10 +10,10 @@ export function DropdownMenuTrigger(props) {
|
|
|
10
10
|
return (_jsx(DropdownMenuPrimitive.Trigger, { "data-slot": "dropdown-menu-trigger", ...props }));
|
|
11
11
|
}
|
|
12
12
|
export function DropdownMenuContent({ className, sideOffset = 4, ...props }) {
|
|
13
|
-
return (_jsx(DropdownMenuPrimitive.Portal, { children: _jsx(DropdownMenuPrimitive.Content, { className: cn("data-[state=closed]:fade-out-0 data-[state=closed]:zoom-out-95 material-menu z-50 max-h-(--radix-dropdown-menu-content-available-height) min-w-[8rem] origin-(--radix-dropdown-menu-content-transform-origin) overflow-y-auto overflow-x-hidden overscroll-contain p-
|
|
13
|
+
return (_jsx(DropdownMenuPrimitive.Portal, { children: _jsx(DropdownMenuPrimitive.Content, { className: cn("data-[state=closed]:fade-out-0 data-[state=closed]:zoom-out-95 material-menu z-50 max-h-(--radix-dropdown-menu-content-available-height) min-w-[8rem] origin-(--radix-dropdown-menu-content-transform-origin) overflow-y-auto overflow-x-hidden overscroll-contain p-(--ds-popover-padding) text-gray-1000 data-[state=closed]:animate-out motion-reduce:animate-none", className), "data-slot": "dropdown-menu-content", sideOffset: sideOffset, ...props }) }));
|
|
14
14
|
}
|
|
15
15
|
export function DropdownMenuItem({ className, inset, variant = "default", ...props }) {
|
|
16
|
-
return (_jsx(DropdownMenuPrimitive.Item, { className: cn("data-[variant=destructive]:*:[svg]:!text-red-800 relative flex cursor-default touch-manipulation select-none items-center gap-2 rounded-
|
|
16
|
+
return (_jsx(DropdownMenuPrimitive.Item, { className: cn("data-[variant=destructive]:*:[svg]:!text-red-800 relative flex cursor-default touch-manipulation select-none items-center gap-2 rounded-(--ds-popover-row-radius) px-2 py-1.5 text-label-14 outline-hidden focus:bg-gray-100 focus:text-gray-1000 data-[disabled]:pointer-events-none data-[inset]:pl-8 data-[variant=destructive]:text-red-800 data-[disabled]:opacity-50 data-[variant=destructive]:focus:bg-red-800/10 data-[variant=destructive]:focus:text-red-800 dark:data-[variant=destructive]:focus:bg-red-800/20 [&_svg:not([class*='size-'])]:size-4 [&_svg:not([class*='text-'])]:text-gray-900 [&_svg]:pointer-events-none [&_svg]:shrink-0", className), "data-inset": inset, "data-slot": "dropdown-menu-item", "data-variant": variant, ...props }));
|
|
17
17
|
}
|
|
18
18
|
export function DropdownMenuLabel({ className, inset, ...props }) {
|
|
19
19
|
return (_jsx(DropdownMenuPrimitive.Label, { className: cn("px-2 py-1.5 font-medium text-sm data-[inset]:pl-8", className), "data-inset": inset, "data-slot": "dropdown-menu-label", ...props }));
|
|
@@ -22,20 +22,20 @@ export function DropdownMenuSeparator({ className, ...props }) {
|
|
|
22
22
|
return (_jsx(DropdownMenuPrimitive.Separator, { className: cn("-mx-1 my-1 h-px bg-gray-alpha-400", className), "data-slot": "dropdown-menu-separator", ...props }));
|
|
23
23
|
}
|
|
24
24
|
export function DropdownMenuCheckboxItem({ className, children, checked, ...props }) {
|
|
25
|
-
return (_jsxs(DropdownMenuPrimitive.CheckboxItem, { checked: checked, className: cn("relative flex cursor-default select-none items-center gap-2 rounded-
|
|
25
|
+
return (_jsxs(DropdownMenuPrimitive.CheckboxItem, { checked: checked, className: cn("relative flex cursor-default select-none items-center gap-2 rounded-(--ds-popover-row-radius) py-1.5 pr-2 pl-8 text-sm outline-hidden focus:bg-gray-100 focus:text-gray-1000 data-[disabled]:pointer-events-none data-[disabled]:opacity-50 [&_svg:not([class*='size-'])]:size-4 [&_svg]:pointer-events-none [&_svg]:shrink-0", className), "data-slot": "dropdown-menu-checkbox-item", ...props, children: [_jsx("span", { className: "pointer-events-none absolute left-2 flex size-3.5 items-center justify-center", children: _jsx(DropdownMenuPrimitive.ItemIndicator, { children: _jsx(IconCheck, { className: "size-4" }) }) }), children] }));
|
|
26
26
|
}
|
|
27
27
|
export function DropdownMenuRadioGroup(props) {
|
|
28
28
|
return (_jsx(DropdownMenuPrimitive.RadioGroup, { "data-slot": "dropdown-menu-radio-group", ...props }));
|
|
29
29
|
}
|
|
30
30
|
export function DropdownMenuRadioItem({ className, children, ...props }) {
|
|
31
|
-
return (_jsxs(DropdownMenuPrimitive.RadioItem, { className: cn("relative flex cursor-default select-none items-center gap-2 rounded-
|
|
31
|
+
return (_jsxs(DropdownMenuPrimitive.RadioItem, { className: cn("relative flex cursor-default select-none items-center gap-2 rounded-(--ds-popover-row-radius) py-1.5 pr-2 pl-8 text-sm outline-hidden focus:bg-gray-100 focus:text-gray-1000 data-[disabled]:pointer-events-none data-[disabled]:opacity-50 [&_svg:not([class*='size-'])]:size-4 [&_svg]:pointer-events-none [&_svg]:shrink-0", className), "data-slot": "dropdown-menu-radio-item", ...props, children: [_jsx("span", { className: "pointer-events-none absolute left-2 flex size-3.5 items-center justify-center", children: _jsx(DropdownMenuPrimitive.ItemIndicator, { children: _jsx(IconCircle, { className: "size-2 fill-current" }) }) }), children] }));
|
|
32
32
|
}
|
|
33
33
|
export function DropdownMenuSub(props) {
|
|
34
34
|
return _jsx(DropdownMenuPrimitive.Sub, { "data-slot": "dropdown-menu-sub", ...props });
|
|
35
35
|
}
|
|
36
36
|
export function DropdownMenuSubTrigger({ className, inset, children, ...props }) {
|
|
37
|
-
return (_jsxs(DropdownMenuPrimitive.SubTrigger, { className: cn("flex cursor-default touch-manipulation select-none items-center gap-2 rounded-
|
|
37
|
+
return (_jsxs(DropdownMenuPrimitive.SubTrigger, { className: cn("flex cursor-default touch-manipulation select-none items-center gap-2 rounded-(--ds-popover-row-radius) px-2 py-1.5 text-label-14 outline-hidden focus:bg-gray-100 focus:text-gray-1000 data-[state=open]:bg-gray-100 data-[inset]:pl-8 data-[state=open]:text-gray-1000 [&_svg:not([class*='size-'])]:size-4 [&_svg:not([class*='text-'])]:text-gray-900 [&_svg]:pointer-events-none [&_svg]:shrink-0", className), "data-inset": inset, "data-slot": "dropdown-menu-sub-trigger", ...props, children: [children, _jsx(IconChevronRight, { className: "ml-auto size-4" })] }));
|
|
38
38
|
}
|
|
39
39
|
export function DropdownMenuSubContent({ className, ...props }) {
|
|
40
|
-
return (_jsx(DropdownMenuPrimitive.SubContent, { className: cn("data-[state=closed]:fade-out-0 data-[state=closed]:zoom-out-95 material-menu z-50 min-w-[8rem] origin-(--radix-dropdown-menu-content-transform-origin) overflow-hidden overscroll-contain p-
|
|
40
|
+
return (_jsx(DropdownMenuPrimitive.SubContent, { className: cn("data-[state=closed]:fade-out-0 data-[state=closed]:zoom-out-95 material-menu z-50 min-w-[8rem] origin-(--radix-dropdown-menu-content-transform-origin) overflow-hidden overscroll-contain p-(--ds-popover-padding) text-gray-1000 data-[state=closed]:animate-out motion-reduce:animate-none", className), "data-slot": "dropdown-menu-sub-content", ...props }));
|
|
41
41
|
}
|
package/dist/layout.d.ts
CHANGED
|
@@ -3,6 +3,7 @@ import type { ComponentProps, ReactNode } from "react";
|
|
|
3
3
|
import type { GeistdocsConfig } from "./config";
|
|
4
4
|
import { type GeistdocsSidebarMode } from "./sidebar";
|
|
5
5
|
export declare const GeistdocsProvider: (props: import("./internal/provider-client").GeistdocsProviderProps) => import("react/jsx-runtime").JSX.Element;
|
|
6
|
+
export declare const GeistdocsThemeScript: () => import("react/jsx-runtime").JSX.Element;
|
|
6
7
|
interface GeistdocsDocsLayoutProps {
|
|
7
8
|
children: ReactNode;
|
|
8
9
|
config: Pick<GeistdocsConfig, "defaultLanguage" | "translations">;
|
package/dist/layout.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"layout.d.ts","sourceRoot":"","sources":["../src/layout.tsx"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"layout.d.ts","sourceRoot":"","sources":["../src/layout.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,IAAI,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAC5E,OAAO,KAAK,EAAE,cAAc,EAAiB,SAAS,EAAE,MAAM,OAAO,CAAC;AACtE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAIhD,OAAO,EAAE,KAAK,oBAAoB,EAA4B,MAAM,WAAW,CAAC;AAEhF,eAAO,MAAM,iBAAiB,iHAA0B,CAAC;AAEzD,eAAO,MAAM,oBAAoB,+CAEhC,CAAC;AAEF,UAAU,wBAAwB;IAChC,QAAQ,EAAE,SAAS,CAAC;IACpB,MAAM,EAAE,IAAI,CAAC,eAAe,EAAE,iBAAiB,GAAG,cAAc,CAAC,CAAC;IAClE,cAAc,CAAC,EAAE,cAAc,CAAC,OAAO,kBAAkB,CAAC,CAAC,gBAAgB,CAAC,CAAC;IAC7E,WAAW,CAAC,EAAE,oBAAoB,CAAC;IACnC,UAAU,CAAC,EAAE,SAAS,CAAC;IACvB,IAAI,EAAE,cAAc,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC;CACzD;AAED,eAAO,MAAM,mBAAmB,GAAI,sEAOjC,wBAAwB,4CAkC1B,CAAC"}
|
package/dist/layout.js
CHANGED
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
import { jsx as _jsx } from "react/jsx-runtime";
|
|
2
|
+
import { GeistThemeScript } from "@vercel/geistcn/core";
|
|
2
3
|
import { DocsLayout as FumadocsDocsLayout } from "fumadocs-ui/layouts/docs";
|
|
3
4
|
import { createGeistdocsI18n } from "./internal/i18n";
|
|
4
5
|
import { GeistdocsProvider as GeistdocsProviderClient } from "./internal/provider-client";
|
|
5
6
|
import { GeistdocsSidebar } from "./internal/sidebar";
|
|
6
7
|
import { GeistdocsSidebarProvider } from "./sidebar";
|
|
7
8
|
export const GeistdocsProvider = GeistdocsProviderClient;
|
|
9
|
+
export const GeistdocsThemeScript = () => (_jsx(GeistThemeScript, { storageKey: "geistdocs-theme" }));
|
|
8
10
|
export const GeistdocsDocsLayout = ({ config, containerProps, sidebarMode, sidebarTop, tree, children, }) => {
|
|
9
11
|
const { i18n } = createGeistdocsI18n(config);
|
|
10
12
|
return (_jsx(GeistdocsSidebarProvider, { children: _jsx(FumadocsDocsLayout, { containerProps: {
|
package/dist/mdx.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"mdx.d.ts","sourceRoot":"","sources":["../src/mdx.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;
|
|
1
|
+
{"version":3,"file":"mdx.d.ts","sourceRoot":"","sources":["../src/mdx.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAsB/C,OAAO,EAGL,KAAK,4BAA4B,IAAI,mBAAmB,EAGzD,MAAM,iBAAiB,CAAC;AAEzB,eAAO,MAAM,2BAA2B,8EAAe,CAAC;AACxD,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gCAAoB,CAAC;AAC5D,eAAO,MAAM,mBAAmB;;;;;;;gCAAa,CAAC;AAC9C,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;CAAa,CAAC;AAC1C,MAAM,MAAM,4BAA4B,GAAG,mBAAmB,CAAC;AAI/D,MAAM,MAAM,sBAAsB,GAAG,aAAa,CAAC;AAEnD,eAAO,MAAM,yBAAyB,GACpC,aAAa,sBAAsB,KAClC,sBA2DD,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
|
@@ -8,7 +8,9 @@ import { Callout, CalloutContainer, CalloutDescription, CalloutTitle, } from "./
|
|
|
8
8
|
import { CodeBlock } from "./components/code-block";
|
|
9
9
|
import { CodeBlockTab, CodeBlockTabs, CodeBlockTabsList, CodeBlockTabsTrigger, CompactCodeBlockTabs, } from "./components/code-block-tabs";
|
|
10
10
|
import { CopyPrompt } from "./components/copy-prompt";
|
|
11
|
+
import { Heading } from "./components/heading";
|
|
11
12
|
import { Mermaid } from "./components/mermaid";
|
|
13
|
+
import { Table } from "./components/table";
|
|
12
14
|
import { Video } from "./components/video";
|
|
13
15
|
import { LocalizedLink } from "./internal/localized-link";
|
|
14
16
|
import { geistdocsFrontmatterSchema as frontmatterSchema, geistdocsMetaSchema as metaSchema, geistShikiTheme as shikiTheme, defineGeistdocsSourceConfig as sourceConfig, } from "./source-config";
|
|
@@ -19,9 +21,16 @@ export const geistShikiTheme = shikiTheme;
|
|
|
19
21
|
const HTTP_URL = /^https?:\/\//;
|
|
20
22
|
export const getGeistdocsMDXComponents = (components) => ({
|
|
21
23
|
...defaultMdxComponents,
|
|
24
|
+
h1: (props) => _jsx(Heading, { as: "h1", ...props }),
|
|
25
|
+
h2: (props) => _jsx(Heading, { as: "h2", ...props }),
|
|
26
|
+
h3: (props) => _jsx(Heading, { as: "h3", ...props }),
|
|
27
|
+
h4: (props) => _jsx(Heading, { as: "h4", ...props }),
|
|
28
|
+
h5: (props) => _jsx(Heading, { as: "h5", ...props }),
|
|
29
|
+
h6: (props) => _jsx(Heading, { as: "h6", ...props }),
|
|
22
30
|
pre: CodeBlock,
|
|
23
31
|
blockquote: Blockquote,
|
|
24
|
-
|
|
32
|
+
table: Table,
|
|
33
|
+
a: ({ children, className, href, ...props }) => typeof href === "string" && href.startsWith("/") ? (_jsx(LocalizedLink, { 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: href, ...props, children: children })) : (_jsxs("a", { className: cn("group font-normal text-gray-1000! no-underline hover:text-gray-1000! hover:opacity-100!", className), href: href, ...props, children: [_jsx("span", { className: "underline decoration-1 decoration-gray-700 underline-offset-4 group-hover:decoration-gray-1000", children: children }), typeof href === "string" && HTTP_URL.test(href) ? (_jsxs("span", { className: "whitespace-nowrap", children: ["\u00a0", _jsx("span", { className: "inline-flex -translate-y-1 align-text-bottom", children: _jsx(IconArrowUpRightSmall, { size: 16 }) })] })) : null] })),
|
|
25
34
|
CodeBlockTabs,
|
|
26
35
|
CompactCodeBlockTabs,
|
|
27
36
|
CodeBlockTabsList,
|
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":"AAGA,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;AAa9E,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;AAEF,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;
|
|
1
|
+
{"version":3,"file":"docs.d.ts","sourceRoot":"","sources":["../../src/pages/docs.tsx"],"names":[],"mappings":"AAGA,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;AAa9E,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;AAEF,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;AAmCD,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,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,UAAU,qBAAqB;IAC7B,MAAM,EAAE,IAAI,CACV,eAAe,EACb,IAAI,GACJ,UAAU,GACV,UAAU,GACV,QAAQ,GACR,aAAa,GACb,QAAQ,GACR,SAAS,CACZ,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;AAyCD,eAAO,MAAM,cAAc,GAAI,6LAe5B,qBAAqB;wBAiMnB;QACD,MAAM,EAAE,OAAO,CAAC;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;SAAE,CAAC,CAAC;KACpD;;oCAcE;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;CAwDtB,CAAC;AAEF,eAAO,MAAM,iBAAiB;;;CAA4B,CAAC"}
|
package/dist/pages/docs.js
CHANGED
|
@@ -19,7 +19,7 @@ import { getPageRobots, } from "../page-visibility";
|
|
|
19
19
|
const HTTP_URL = /^https?:\/\//;
|
|
20
20
|
const PrefetchedDocsLink = ({ children, className, href, ...props }) => {
|
|
21
21
|
const external = typeof href === "string" && HTTP_URL.test(href);
|
|
22
|
-
return (_jsxs(Link, { ...props, className: cn("font-normal text-gray-1000!
|
|
22
|
+
return (_jsxs(Link, { ...props, className: cn("group font-normal text-gray-1000! no-underline hover:text-gray-1000! hover:opacity-100!", className), href: href, prefetch: !external, children: [_jsx("span", { className: "underline decoration-1 decoration-gray-700 underline-offset-4 group-hover:decoration-gray-1000", children: children }), external ? (_jsxs("span", { className: "whitespace-nowrap", children: ["\u00a0", _jsx("span", { className: "inline-flex -translate-y-1 align-text-bottom", children: _jsx(IconArrowUpRightSmall, { size: 16 }) })] })) : null] }));
|
|
23
23
|
};
|
|
24
24
|
export const resolvePageMarkdownUrl = (options) => resolveInternalPageMarkdownUrl(options);
|
|
25
25
|
const DocsTitle = ({ className, ...props }) => (_jsx(FumadocsDocsTitle, { className: cn("mb-4 text-balance", className), ...props }));
|
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, IconChevronDownSmall, } 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(IconChevronDownSmall, { className: "size-4 shrink-0 text-gray-900 transition-transform duration-150 ease-[cubic-bezier(0.175,0.885,0.32,1.1)] group-data-[state=open]:rotate-180 motion-reduce:transition-none" })] }) }), _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.fdff126 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` 1.25.1-canary.
|
|
3
|
+
These docs are bundled with `@vercel/geistdocs` 1.25.1-canary.fdff126.
|
|
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
|
|
@@ -1256,11 +1256,17 @@ Headings automatically generate anchor links for navigation and deep linking.
|
|
|
1256
1256
|
|
|
1257
1257
|
Create unordered lists with `-`, `*`, or `+`:
|
|
1258
1258
|
|
|
1259
|
-
|
|
1260
|
-
-
|
|
1261
|
-
|
|
1262
|
-
|
|
1263
|
-
|
|
1259
|
+
```md
|
|
1260
|
+
- Install the required packages
|
|
1261
|
+
- Configure your project
|
|
1262
|
+
- Start the development server
|
|
1263
|
+
```
|
|
1264
|
+
|
|
1265
|
+
This renders as:
|
|
1266
|
+
|
|
1267
|
+
- Install the required packages
|
|
1268
|
+
- Configure your project
|
|
1269
|
+
- Start the development server
|
|
1264
1270
|
|
|
1265
1271
|
Create ordered lists with numbers:
|
|
1266
1272
|
|
|
@@ -1286,6 +1292,51 @@ This renders as:
|
|
|
1286
1292
|
|
|
1287
1293
|
> This is automatically set when deploying to Vercel.
|
|
1288
1294
|
|
|
1295
|
+
Callouts can also contain a title and lists:
|
|
1296
|
+
|
|
1297
|
+
> Note:
|
|
1298
|
+
- The `App Router` uses [React canary
|
|
1299
|
+
releases](https://react.dev/blog/2023/05/03/react-canaries) built-in, which
|
|
1300
|
+
include all the stable React 19 changes, as well as newer features being
|
|
1301
|
+
validated in frameworks, but you should still declare react and react-dom in
|
|
1302
|
+
package.json for tooling and ecosystem compatibility.
|
|
1303
|
+
- The `Pages Router` uses the React version from your `package.json`.
|
|
1304
|
+
|
|
1305
|
+
### Copy Prompts
|
|
1306
|
+
|
|
1307
|
+
Short prompts render in full without an expansion control:
|
|
1308
|
+
|
|
1309
|
+
```mdx
|
|
1310
|
+
<CopyPrompt text="Summarize this documentation page and list the key concepts.">
|
|
1311
|
+
Summarize this documentation page and list the key concepts.
|
|
1312
|
+
</CopyPrompt>
|
|
1313
|
+
```
|
|
1314
|
+
|
|
1315
|
+
This renders as:
|
|
1316
|
+
|
|
1317
|
+
Summarize this documentation page and list the key concepts.
|
|
1318
|
+
|
|
1319
|
+
Long prompts initially show a preview with a **Show more** control:
|
|
1320
|
+
|
|
1321
|
+
```mdx
|
|
1322
|
+
<CopyPrompt collapsible text="Write a detailed migration plan for this project.">
|
|
1323
|
+
Write a detailed migration plan for this project. Include prerequisites,
|
|
1324
|
+
implementation steps, validation, rollback guidance, and common pitfalls.
|
|
1325
|
+
</CopyPrompt>
|
|
1326
|
+
```
|
|
1327
|
+
|
|
1328
|
+
Set the boolean `collapsible` prop when the prompt should initially render as a
|
|
1329
|
+
two-line preview. This renders as:
|
|
1330
|
+
|
|
1331
|
+
Review this Geistdocs project in detail. Explain how the `@vercel/geistdocs`
|
|
1332
|
+
package, application layouts, local adapter files, source configuration,
|
|
1333
|
+
`content/docs` directory, navigation metadata, MDX components, syntax
|
|
1334
|
+
highlighting, search routes, and deployment configuration work together.
|
|
1335
|
+
Then identify the safest first files to edit, describe the effect of each
|
|
1336
|
+
change, call out common mistakes, and propose a step-by-step plan for
|
|
1337
|
+
customizing the documentation site without breaking routing, generated
|
|
1338
|
+
Markdown, or accessibility behavior.
|
|
1339
|
+
|
|
1289
1340
|
### Links
|
|
1290
1341
|
|
|
1291
1342
|
Create links with `[text](url)`:
|
|
@@ -1302,6 +1353,17 @@ path beginning with `/` for internal links:
|
|
|
1302
1353
|
[Internal link](/docs/getting-started)
|
|
1303
1354
|
```
|
|
1304
1355
|
|
|
1356
|
+
External links can also contain inline code. The underline applies to the text,
|
|
1357
|
+
but not the external-link icon:
|
|
1358
|
+
|
|
1359
|
+
```md
|
|
1360
|
+
Run independent requests in parallel with [`Promise.all`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise/all).
|
|
1361
|
+
```
|
|
1362
|
+
|
|
1363
|
+
This renders as:
|
|
1364
|
+
|
|
1365
|
+
Run independent requests in parallel with [`Promise.all`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise/all).
|
|
1366
|
+
|
|
1305
1367
|
### Images
|
|
1306
1368
|
|
|
1307
1369
|
Add images with ``:
|
|
@@ -1334,6 +1396,16 @@ This renders as:
|
|
|
1334
1396
|
| GFM | GitHub extensions | Supported |
|
|
1335
1397
|
| MDX | JSX in Markdown | Supported |
|
|
1336
1398
|
|
|
1399
|
+
Tables can also include inline code, as commonly used for file references:
|
|
1400
|
+
|
|
1401
|
+
| File | Description |
|
|
1402
|
+
| -------------------- | ------------------------------------------------ |
|
|
1403
|
+
| `next.config.js` | Configuration file for Next.js |
|
|
1404
|
+
| `package.json` | Project dependencies and scripts |
|
|
1405
|
+
| `instrumentation.ts` | OpenTelemetry and instrumentation file |
|
|
1406
|
+
| `.env.local` | Local environment variables |
|
|
1407
|
+
| `tsconfig.json` | Configuration file for TypeScript |
|
|
1408
|
+
|
|
1337
1409
|
### Task Lists
|
|
1338
1410
|
|
|
1339
1411
|
Create interactive task lists:
|
package/docs/manifest.json
CHANGED
package/docs/pages/syntax.md
CHANGED
|
@@ -69,11 +69,17 @@ Headings automatically generate anchor links for navigation and deep linking.
|
|
|
69
69
|
|
|
70
70
|
Create unordered lists with `-`, `*`, or `+`:
|
|
71
71
|
|
|
72
|
-
|
|
73
|
-
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
72
|
+
```md
|
|
73
|
+
- Install the required packages
|
|
74
|
+
- Configure your project
|
|
75
|
+
- Start the development server
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
This renders as:
|
|
79
|
+
|
|
80
|
+
- Install the required packages
|
|
81
|
+
- Configure your project
|
|
82
|
+
- Start the development server
|
|
77
83
|
|
|
78
84
|
Create ordered lists with numbers:
|
|
79
85
|
|
|
@@ -99,6 +105,51 @@ This renders as:
|
|
|
99
105
|
|
|
100
106
|
> This is automatically set when deploying to Vercel.
|
|
101
107
|
|
|
108
|
+
Callouts can also contain a title and lists:
|
|
109
|
+
|
|
110
|
+
> Note:
|
|
111
|
+
- The `App Router` uses [React canary
|
|
112
|
+
releases](https://react.dev/blog/2023/05/03/react-canaries) built-in, which
|
|
113
|
+
include all the stable React 19 changes, as well as newer features being
|
|
114
|
+
validated in frameworks, but you should still declare react and react-dom in
|
|
115
|
+
package.json for tooling and ecosystem compatibility.
|
|
116
|
+
- The `Pages Router` uses the React version from your `package.json`.
|
|
117
|
+
|
|
118
|
+
### Copy Prompts
|
|
119
|
+
|
|
120
|
+
Short prompts render in full without an expansion control:
|
|
121
|
+
|
|
122
|
+
```mdx
|
|
123
|
+
<CopyPrompt text="Summarize this documentation page and list the key concepts.">
|
|
124
|
+
Summarize this documentation page and list the key concepts.
|
|
125
|
+
</CopyPrompt>
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
This renders as:
|
|
129
|
+
|
|
130
|
+
Summarize this documentation page and list the key concepts.
|
|
131
|
+
|
|
132
|
+
Long prompts initially show a preview with a **Show more** control:
|
|
133
|
+
|
|
134
|
+
```mdx
|
|
135
|
+
<CopyPrompt collapsible text="Write a detailed migration plan for this project.">
|
|
136
|
+
Write a detailed migration plan for this project. Include prerequisites,
|
|
137
|
+
implementation steps, validation, rollback guidance, and common pitfalls.
|
|
138
|
+
</CopyPrompt>
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
Set the boolean `collapsible` prop when the prompt should initially render as a
|
|
142
|
+
two-line preview. This renders as:
|
|
143
|
+
|
|
144
|
+
Review this Geistdocs project in detail. Explain how the `@vercel/geistdocs`
|
|
145
|
+
package, application layouts, local adapter files, source configuration,
|
|
146
|
+
`content/docs` directory, navigation metadata, MDX components, syntax
|
|
147
|
+
highlighting, search routes, and deployment configuration work together.
|
|
148
|
+
Then identify the safest first files to edit, describe the effect of each
|
|
149
|
+
change, call out common mistakes, and propose a step-by-step plan for
|
|
150
|
+
customizing the documentation site without breaking routing, generated
|
|
151
|
+
Markdown, or accessibility behavior.
|
|
152
|
+
|
|
102
153
|
### Links
|
|
103
154
|
|
|
104
155
|
Create links with `[text](url)`:
|
|
@@ -115,6 +166,17 @@ path beginning with `/` for internal links:
|
|
|
115
166
|
[Internal link](/docs/getting-started)
|
|
116
167
|
```
|
|
117
168
|
|
|
169
|
+
External links can also contain inline code. The underline applies to the text,
|
|
170
|
+
but not the external-link icon:
|
|
171
|
+
|
|
172
|
+
```md
|
|
173
|
+
Run independent requests in parallel with [`Promise.all`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise/all).
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
This renders as:
|
|
177
|
+
|
|
178
|
+
Run independent requests in parallel with [`Promise.all`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise/all).
|
|
179
|
+
|
|
118
180
|
### Images
|
|
119
181
|
|
|
120
182
|
Add images with ``:
|
|
@@ -147,6 +209,16 @@ This renders as:
|
|
|
147
209
|
| GFM | GitHub extensions | Supported |
|
|
148
210
|
| MDX | JSX in Markdown | Supported |
|
|
149
211
|
|
|
212
|
+
Tables can also include inline code, as commonly used for file references:
|
|
213
|
+
|
|
214
|
+
| File | Description |
|
|
215
|
+
| -------------------- | ------------------------------------------------ |
|
|
216
|
+
| `next.config.js` | Configuration file for Next.js |
|
|
217
|
+
| `package.json` | Project dependencies and scripts |
|
|
218
|
+
| `instrumentation.ts` | OpenTelemetry and instrumentation file |
|
|
219
|
+
| `.env.local` | Local environment variables |
|
|
220
|
+
| `tsconfig.json` | Configuration file for TypeScript |
|
|
221
|
+
|
|
150
222
|
### Task Lists
|
|
151
223
|
|
|
152
224
|
Create interactive task lists:
|
package/package.json
CHANGED
|
@@ -3,6 +3,7 @@ import { geistFontClasses } from "@vercel/geistcn/core";
|
|
|
3
3
|
import { cn } from "@vercel/geistcn/utils";
|
|
4
4
|
import "@/lib/geistdocs/site-url-warning";
|
|
5
5
|
import { Footer } from "@vercel/geistdocs/footer";
|
|
6
|
+
import { GeistdocsThemeScript } from "@vercel/geistdocs/layout";
|
|
6
7
|
import { Navbar } from "@vercel/geistdocs/navbar";
|
|
7
8
|
import type { Metadata } from "next";
|
|
8
9
|
import { GeistdocsProvider } from "@/components/geistdocs/provider";
|
|
@@ -30,6 +31,9 @@ const Layout = async ({ children }: LayoutProps<"/[lang]">) => {
|
|
|
30
31
|
lang={lang}
|
|
31
32
|
suppressHydrationWarning
|
|
32
33
|
>
|
|
34
|
+
<head>
|
|
35
|
+
<GeistdocsThemeScript />
|
|
36
|
+
</head>
|
|
33
37
|
<body style={{ backgroundColor: "var(--ds-background-200)" }}>
|
|
34
38
|
<GeistdocsProvider basePath={config.basePath} lang={lang}>
|
|
35
39
|
<Navbar config={config} />
|
|
@@ -67,11 +67,17 @@ Headings automatically generate anchor links for navigation and deep linking.
|
|
|
67
67
|
|
|
68
68
|
Create unordered lists with `-`, `*`, or `+`:
|
|
69
69
|
|
|
70
|
-
|
|
71
|
-
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
70
|
+
```md
|
|
71
|
+
- Install the required packages
|
|
72
|
+
- Configure your project
|
|
73
|
+
- Start the development server
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
This renders as:
|
|
77
|
+
|
|
78
|
+
- Install the required packages
|
|
79
|
+
- Configure your project
|
|
80
|
+
- Start the development server
|
|
75
81
|
|
|
76
82
|
Create ordered lists with numbers:
|
|
77
83
|
|
|
@@ -97,6 +103,56 @@ This renders as:
|
|
|
97
103
|
|
|
98
104
|
<Callout>This is automatically set when deploying to Vercel.</Callout>
|
|
99
105
|
|
|
106
|
+
Callouts can also contain a title and lists:
|
|
107
|
+
|
|
108
|
+
<Callout title="Good to know">
|
|
109
|
+
- The `App Router` uses [React canary
|
|
110
|
+
releases](https://react.dev/blog/2023/05/03/react-canaries) built-in, which
|
|
111
|
+
include all the stable React 19 changes, as well as newer features being
|
|
112
|
+
validated in frameworks, but you should still declare react and react-dom in
|
|
113
|
+
package.json for tooling and ecosystem compatibility.
|
|
114
|
+
- The `Pages Router` uses the React version from your `package.json`.
|
|
115
|
+
</Callout>
|
|
116
|
+
|
|
117
|
+
### Copy Prompts
|
|
118
|
+
|
|
119
|
+
Short prompts render in full without an expansion control:
|
|
120
|
+
|
|
121
|
+
```mdx
|
|
122
|
+
<CopyPrompt text="Summarize this documentation page and list the key concepts.">
|
|
123
|
+
Summarize this documentation page and list the key concepts.
|
|
124
|
+
</CopyPrompt>
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
This renders as:
|
|
128
|
+
|
|
129
|
+
<CopyPrompt text="Summarize this documentation page and list the key concepts.">
|
|
130
|
+
Summarize this documentation page and list the key concepts.
|
|
131
|
+
</CopyPrompt>
|
|
132
|
+
|
|
133
|
+
Long prompts initially show a preview with a **Show more** control:
|
|
134
|
+
|
|
135
|
+
```mdx
|
|
136
|
+
<CopyPrompt collapsible text="Write a detailed migration plan for this project.">
|
|
137
|
+
Write a detailed migration plan for this project. Include prerequisites,
|
|
138
|
+
implementation steps, validation, rollback guidance, and common pitfalls.
|
|
139
|
+
</CopyPrompt>
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
Set the boolean `collapsible` prop when the prompt should initially render as a
|
|
143
|
+
two-line preview. This renders as:
|
|
144
|
+
|
|
145
|
+
<CopyPrompt collapsible text="Review this Geistdocs project in detail. Explain how the @vercel/geistdocs package, application layouts, local adapter files, source configuration, content/docs directory, navigation metadata, MDX components, syntax highlighting, search routes, and deployment configuration work together. Then identify the safest first files to edit, describe the effect of each change, call out common mistakes, and propose a step-by-step plan for customizing the documentation site without breaking routing, generated Markdown, or accessibility behavior.">
|
|
146
|
+
Review this Geistdocs project in detail. Explain how the `@vercel/geistdocs`
|
|
147
|
+
package, application layouts, local adapter files, source configuration,
|
|
148
|
+
`content/docs` directory, navigation metadata, MDX components, syntax
|
|
149
|
+
highlighting, search routes, and deployment configuration work together.
|
|
150
|
+
Then identify the safest first files to edit, describe the effect of each
|
|
151
|
+
change, call out common mistakes, and propose a step-by-step plan for
|
|
152
|
+
customizing the documentation site without breaking routing, generated
|
|
153
|
+
Markdown, or accessibility behavior.
|
|
154
|
+
</CopyPrompt>
|
|
155
|
+
|
|
100
156
|
### Links
|
|
101
157
|
|
|
102
158
|
Create links with `[text](url)`:
|
|
@@ -113,6 +169,17 @@ path beginning with `/` for internal links:
|
|
|
113
169
|
[Internal link](/docs/getting-started)
|
|
114
170
|
```
|
|
115
171
|
|
|
172
|
+
External links can also contain inline code. The underline applies to the text,
|
|
173
|
+
but not the external-link icon:
|
|
174
|
+
|
|
175
|
+
```md
|
|
176
|
+
Run independent requests in parallel with [`Promise.all`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise/all).
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
This renders as:
|
|
180
|
+
|
|
181
|
+
Run independent requests in parallel with [`Promise.all`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise/all).
|
|
182
|
+
|
|
116
183
|
### Images
|
|
117
184
|
|
|
118
185
|
Add images with ``:
|
|
@@ -145,6 +212,16 @@ This renders as:
|
|
|
145
212
|
| GFM | GitHub extensions | Supported |
|
|
146
213
|
| MDX | JSX in Markdown | Supported |
|
|
147
214
|
|
|
215
|
+
Tables can also include inline code, as commonly used for file references:
|
|
216
|
+
|
|
217
|
+
| File | Description |
|
|
218
|
+
| -------------------- | ------------------------------------------------ |
|
|
219
|
+
| `next.config.js` | Configuration file for Next.js |
|
|
220
|
+
| `package.json` | Project dependencies and scripts |
|
|
221
|
+
| `instrumentation.ts` | OpenTelemetry and instrumentation file |
|
|
222
|
+
| `.env.local` | Local environment variables |
|
|
223
|
+
| `tsconfig.json` | Configuration file for TypeScript |
|
|
224
|
+
|
|
148
225
|
### Task Lists
|
|
149
226
|
|
|
150
227
|
Create interactive task lists:
|
package/template/package.json
CHANGED
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
"@vercel/analytics": "^1.6.1",
|
|
20
20
|
"@vercel/geistcn": "1.0.3",
|
|
21
21
|
"@vercel/geistcn-assets": "2.0.1",
|
|
22
|
-
"@vercel/geistdocs": "1.25.1-canary.
|
|
22
|
+
"@vercel/geistdocs": "1.25.1-canary.fdff126",
|
|
23
23
|
"@vercel/speed-insights": "^1.3.1",
|
|
24
24
|
"ai": "^6.0.132",
|
|
25
25
|
"class-variance-authority": "^0.7.1",
|