@vercel/geistdocs 1.25.1-canary.9556d32 → 1.25.1-canary.b6fcbed

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.
Files changed (48) hide show
  1. package/dist/cli/index.js +1 -1
  2. package/dist/components/blockquote.d.ts +3 -0
  3. package/dist/components/blockquote.d.ts.map +1 -0
  4. package/dist/components/blockquote.js +3 -0
  5. package/dist/components/callout.d.ts +13 -10
  6. package/dist/components/callout.d.ts.map +1 -1
  7. package/dist/components/callout.js +6 -6
  8. package/dist/components/code-block-tabs.d.ts +5 -2
  9. package/dist/components/code-block-tabs.d.ts.map +1 -1
  10. package/dist/components/code-block-tabs.js +29 -4
  11. package/dist/components/code-block.d.ts +1 -1
  12. package/dist/components/code-block.d.ts.map +1 -1
  13. package/dist/components/code-block.js +27 -2
  14. package/dist/components/copy-prompt.d.ts +2 -1
  15. package/dist/components/copy-prompt.d.ts.map +1 -1
  16. package/dist/components/copy-prompt.js +2 -2
  17. package/dist/components/heading.d.ts +7 -0
  18. package/dist/components/heading.d.ts.map +1 -0
  19. package/dist/components/heading.js +14 -0
  20. package/dist/components/table.d.ts +3 -0
  21. package/dist/components/table.d.ts.map +1 -0
  22. package/dist/components/table.js +3 -0
  23. package/dist/controls.js +1 -1
  24. package/dist/internal/chat/prompt-input.d.ts.map +1 -1
  25. package/dist/internal/chat/prompt-input.js +2 -1
  26. package/dist/internal/page-actions-client.d.ts.map +1 -1
  27. package/dist/internal/page-actions-client.js +1 -2
  28. package/dist/internal/search.d.ts.map +1 -1
  29. package/dist/internal/search.js +2 -2
  30. package/dist/internal/sidebar.d.ts.map +1 -1
  31. package/dist/internal/sidebar.js +17 -14
  32. package/dist/internal/table-of-contents.d.ts.map +1 -1
  33. package/dist/internal/table-of-contents.js +1 -1
  34. package/dist/mdx.d.ts.map +1 -1
  35. package/dist/mdx.js +18 -3
  36. package/dist/pages/docs.d.ts.map +1 -1
  37. package/dist/pages/docs.js +7 -2
  38. package/docs/agents.md +1 -1
  39. package/docs/llms.txt +169 -13
  40. package/docs/manifest.json +1 -1
  41. package/docs/pages/migration.md +1 -1
  42. package/docs/pages/syntax.md +167 -11
  43. package/package.json +3 -3
  44. package/template/app/styles/geistdocs.css +1 -1
  45. package/template/content/docs/migration.mdx +1 -1
  46. package/template/content/docs/syntax.mdx +172 -11
  47. package/template/package.json +2 -2
  48. package/theme.css +44 -43
package/dist/mdx.js CHANGED
@@ -1,11 +1,16 @@
1
- import { jsx as _jsx } from "react/jsx-runtime";
1
+ import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
2
+ import { cn } from "@vercel/geistcn/utils";
3
+ import { IconArrowUpRightSmall } from "@vercel/geistcn-assets/icons";
2
4
  import { TypeTable } from "fumadocs-ui/components/type-table";
3
5
  import defaultMdxComponents from "fumadocs-ui/mdx";
6
+ import { Blockquote } from "./components/blockquote";
4
7
  import { Callout, CalloutContainer, CalloutDescription, CalloutTitle, } from "./components/callout";
5
8
  import { CodeBlock } from "./components/code-block";
6
- import { CodeBlockTab, CodeBlockTabs, CodeBlockTabsList, CodeBlockTabsTrigger, } from "./components/code-block-tabs";
9
+ import { CodeBlockTab, CodeBlockTabs, CodeBlockTabsList, CodeBlockTabsTrigger, CompactCodeBlockTabs, } from "./components/code-block-tabs";
7
10
  import { CopyPrompt } from "./components/copy-prompt";
11
+ import { Heading } from "./components/heading";
8
12
  import { Mermaid } from "./components/mermaid";
13
+ import { Table } from "./components/table";
9
14
  import { Video } from "./components/video";
10
15
  import { LocalizedLink } from "./internal/localized-link";
11
16
  import { geistdocsFrontmatterSchema as frontmatterSchema, geistdocsMetaSchema as metaSchema, geistShikiTheme as shikiTheme, defineGeistdocsSourceConfig as sourceConfig, } from "./source-config";
@@ -13,11 +18,21 @@ export const defineGeistdocsSourceConfig = sourceConfig;
13
18
  export const geistdocsFrontmatterSchema = frontmatterSchema;
14
19
  export const geistdocsMetaSchema = metaSchema;
15
20
  export const geistShikiTheme = shikiTheme;
21
+ const HTTP_URL = /^https?:\/\//;
16
22
  export const getGeistdocsMDXComponents = (components) => ({
17
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 }),
18
30
  pre: CodeBlock,
19
- a: ({ href, ...props }) => typeof href === "string" && href.startsWith("/") ? (_jsx(LocalizedLink, { className: "font-normal text-gray-1000 no-underline", href: href, ...props })) : (_jsx("a", { href: href, ...props, className: "font-normal text-gray-1000 no-underline" })),
31
+ blockquote: Blockquote,
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("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, 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] })),
20
34
  CodeBlockTabs,
35
+ CompactCodeBlockTabs,
21
36
  CodeBlockTabsList,
22
37
  CodeBlockTabsTrigger,
23
38
  CodeBlockTab,
@@ -1 +1 @@
1
- {"version":3,"file":"docs.d.ts","sourceRoot":"","sources":["../../src/pages/docs.tsx"],"names":[],"mappings":"AAEA,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;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;AAMD,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"}
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;AAiCD,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"}
@@ -1,5 +1,6 @@
1
- import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
1
+ import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
2
2
  import { cn } from "@vercel/geistcn/utils";
3
+ import { IconArrowUpRightSmall } from "@vercel/geistcn-assets/icons";
3
4
  import Link from "fumadocs-core/link";
4
5
  import { DocsBody as FumadocsDocsBody, DocsDescription as FumadocsDocsDescription, DocsPage as FumadocsDocsPage, DocsTitle as FumadocsDocsTitle, } from "fumadocs-ui/layouts/docs/page";
5
6
  import { createRelativeLink } from "fumadocs-ui/mdx";
@@ -15,7 +16,11 @@ 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 PrefetchedDocsLink = (props) => (_jsx(Link, { ...props, prefetch: true }));
19
+ const HTTP_URL = /^https?:\/\//;
20
+ const PrefetchedDocsLink = ({ children, className, href, ...props }) => {
21
+ const external = typeof href === "string" && HTTP_URL.test(href);
22
+ return (_jsxs(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: href, prefetch: !external, 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
+ };
19
24
  export const resolvePageMarkdownUrl = (options) => resolveInternalPageMarkdownUrl(options);
20
25
  const DocsTitle = ({ className, ...props }) => (_jsx(FumadocsDocsTitle, { className: cn("mb-4 text-balance", className), ...props }));
21
26
  const DocsDescription = ({ className, ...props }) => (_jsx(FumadocsDocsDescription, { className: cn("text-gray-900", className), ...props }));
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.9556d32 so agents can understand the installed package without web access.
3
+ These docs are bundled with `@vercel/geistdocs` 1.25.1-canary.b6fcbed 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.9556d32.
3
+ These docs are bundled with `@vercel/geistdocs` 1.25.1-canary.b6fcbed.
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
@@ -423,7 +423,7 @@ Fix unrelated build failures first. A migration is safer when the starting point
423
423
 
424
424
  ## Install Geistdocs
425
425
 
426
- Add `@vercel/geistdocs` and align the supported Fumadocs and Next.js dependencies for the package version you are adopting.
426
+ Add `@vercel/geistdocs` and align the supported Fumadocs and Next.js dependencies for the package version you are adopting. Geistdocs requires Next.js 16.3.3 or later within 16.x. Earlier 16.3 releases can retain an optional catch-all route's index content after a client navigation to a child page when Cache Components and Partial Prefetching are enabled.
427
427
 
428
428
  For an existing project, use your package manager directly:
429
429
 
@@ -1202,7 +1202,9 @@ related:
1202
1202
 
1203
1203
  Geistdocs supports MDX, a superset of Markdown that allows you to use JSX components within your documentation. This guide covers all the formatting options available.
1204
1204
 
1205
- Help me write a Geistdocs MDX page. Use this page as a syntax reference and create an example page with frontmatter, headings, links, a code block, a `Callout`, and a `CopyPrompt` component.
1205
+ Help me write a Geistdocs MDX page. Use this page as a syntax reference and
1206
+ create an example page with frontmatter, headings, links, a code block, a
1207
+ `Callout`, and a `CopyPrompt` component.
1206
1208
 
1207
1209
  ## Frontmatter
1208
1210
 
@@ -1254,11 +1256,17 @@ Headings automatically generate anchor links for navigation and deep linking.
1254
1256
 
1255
1257
  Create unordered lists with `-`, `*`, or `+`:
1256
1258
 
1257
- - First item
1258
- - Second item
1259
- - Nested item
1260
- - Another nested item
1261
- - Third item
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
1262
1270
 
1263
1271
  Create ordered lists with numbers:
1264
1272
 
@@ -1270,7 +1278,64 @@ Create ordered lists with numbers:
1270
1278
 
1271
1279
  Use `>` to create blockquotes:
1272
1280
 
1273
- > This is a blockquote. You can use it to highlight important information or quotes from external sources.
1281
+ > **Watch:** Learn more about how to use `next/image` → [YouTube (9 minutes)](https://youtu.be/IU_qq_c_lKA).
1282
+
1283
+ ### Callouts
1284
+
1285
+ Use `<Callout>` for a highlighted informational note:
1286
+
1287
+ ```mdx
1288
+ <Callout>This is automatically set when deploying to Vercel.</Callout>
1289
+ ```
1290
+
1291
+ This renders as:
1292
+
1293
+ > This is automatically set when deploying to Vercel.
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.
1274
1339
 
1275
1340
  ### Links
1276
1341
 
@@ -1279,6 +1344,15 @@ Create links with `[text](url)`:
1279
1344
  - [External link](https://vercel.com)
1280
1345
  - [Internal link](/docs/getting-started)
1281
1346
 
1347
+ Use an absolute `https://` or `http://` URL to mark a link as external. External
1348
+ links open outside the docs site and display an arrow icon. Use a root-relative
1349
+ path beginning with `/` for internal links:
1350
+
1351
+ ```md
1352
+ [External link](https://vercel.com)
1353
+ [Internal link](/docs/getting-started)
1354
+ ```
1355
+
1282
1356
  ### Images
1283
1357
 
1284
1358
  Add images with `![alt text](url)`:
@@ -1311,6 +1385,16 @@ This renders as:
1311
1385
  | GFM | GitHub extensions | Supported |
1312
1386
  | MDX | JSX in Markdown | Supported |
1313
1387
 
1388
+ Tables can also include inline code, as commonly used for file references:
1389
+
1390
+ | File | Description |
1391
+ | -------------------- | ------------------------------------------------ |
1392
+ | `next.config.js` | Configuration file for Next.js |
1393
+ | `package.json` | Project dependencies and scripts |
1394
+ | `instrumentation.ts` | OpenTelemetry and instrumentation file |
1395
+ | `.env.local` | Local environment variables |
1396
+ | `tsconfig.json` | Configuration file for TypeScript |
1397
+
1314
1398
  ### Task Lists
1315
1399
 
1316
1400
  Create interactive task lists:
@@ -1383,6 +1467,78 @@ export const Button = ({ children }) => {
1383
1467
  };
1384
1468
  ```
1385
1469
 
1470
+ ### Tabs and switchers
1471
+
1472
+ Use consecutive fences with `tab` metadata for code tabs that expose every
1473
+ option at once:
1474
+
1475
+ ````md
1476
+ ```ts tab="TypeScript" title="example.ts"
1477
+ export const greeting: string = "Hello from TypeScript";
1478
+ ```
1479
+
1480
+ ```js tab="JavaScript" title="example.js"
1481
+ export const greeting = "Hello from JavaScript";
1482
+ ```
1483
+ ````
1484
+
1485
+ This renders as:
1486
+
1487
+ ```ts tab="TypeScript" title="example.ts"
1488
+ export const greeting: string = "Hello from TypeScript";
1489
+ ```
1490
+
1491
+ ```js tab="JavaScript" title="example.js"
1492
+ export const greeting = "Hello from JavaScript";
1493
+ ```
1494
+
1495
+ Wrap the same fences in `<CodeBlockTabs compact>` to move the selector into the
1496
+ code-block header:
1497
+
1498
+ ````mdx
1499
+ <CompactCodeBlockTabs defaultValue="TypeScript">
1500
+ <CodeBlockTabsList>
1501
+ <CodeBlockTabsTrigger value="TypeScript">TypeScript</CodeBlockTabsTrigger>
1502
+ <CodeBlockTabsTrigger value="JavaScript">JavaScript</CodeBlockTabsTrigger>
1503
+ </CodeBlockTabsList>
1504
+ <CodeBlockTab value="TypeScript">
1505
+ ```ts title="example.ts"
1506
+ export const greeting: string = "Hello from TypeScript";
1507
+ ```
1508
+ </CodeBlockTab>
1509
+ <CodeBlockTab value="JavaScript">
1510
+ ```js title="example.js"
1511
+ export const greeting = "Hello from JavaScript";
1512
+ ```
1513
+ </CodeBlockTab>
1514
+ </CompactCodeBlockTabs>
1515
+ ````
1516
+
1517
+ This renders as:
1518
+
1519
+ <CompactCodeBlockTabs defaultValue="TypeScript">
1520
+ <CodeBlockTabsList>
1521
+ <CodeBlockTabsTrigger value="TypeScript">TypeScript</CodeBlockTabsTrigger>
1522
+ <CodeBlockTabsTrigger value="JavaScript">JavaScript</CodeBlockTabsTrigger>
1523
+ </CodeBlockTabsList>
1524
+ <CodeBlockTab value="TypeScript">
1525
+ ```ts title="example.ts"
1526
+ export const greeting: string = "Hello from TypeScript";
1527
+ ```
1528
+ </CodeBlockTab>
1529
+ <CodeBlockTab value="JavaScript">
1530
+ ```js title="example.js"
1531
+ export const greeting = "Hello from JavaScript";
1532
+ ```
1533
+ </CodeBlockTab>
1534
+ </CompactCodeBlockTabs>
1535
+
1536
+ When migrating an existing site such as next-site, translate adjacent
1537
+ `switcher` fences to `tab="TypeScript"` and `tab="JavaScript"`, then wrap the
1538
+ pair with `<CodeBlockTabs compact>`. Import `@vercel/geistdocs/styles.css` (or
1539
+ `theme.css` with the documented Geist dependencies) so Tailwind scans the
1540
+ package's compiled components and emits the tab layout utilities.
1541
+
1386
1542
  ### Framework icons
1387
1543
 
1388
1544
  Append `#<framework>` to the title to show a framework logo instead of the
@@ -1391,22 +1547,22 @@ values are `#next` / `#nextjs` and `#svelte` / `#sveltekit`:
1391
1547
 
1392
1548
  ````md
1393
1549
  ```ts title="flags.ts#next"
1394
- import { flag } from 'flags/next';
1550
+ import { flag } from "flags/next";
1395
1551
  ```
1396
1552
 
1397
1553
  ```ts title="flags.ts#svelte"
1398
- import { flag } from 'flags/sveltekit';
1554
+ import { flag } from "flags/sveltekit";
1399
1555
  ```
1400
1556
  ````
1401
1557
 
1402
1558
  This renders as:
1403
1559
 
1404
1560
  ```ts title="flags.ts#next"
1405
- import { flag } from 'flags/next';
1561
+ import { flag } from "flags/next";
1406
1562
  ```
1407
1563
 
1408
1564
  ```ts title="flags.ts#svelte"
1409
- import { flag } from 'flags/sveltekit';
1565
+ import { flag } from "flags/sveltekit";
1410
1566
  ```
1411
1567
 
1412
1568
  ### Line Numbers
@@ -199,5 +199,5 @@
199
199
  }
200
200
  ],
201
201
  "source": "apps/template/content/docs",
202
- "version": "1.25.1-canary.9556d32"
202
+ "version": "1.25.1-canary.b6fcbed"
203
203
  }
@@ -44,7 +44,7 @@ Fix unrelated build failures first. A migration is safer when the starting point
44
44
 
45
45
  ## Install Geistdocs
46
46
 
47
- Add `@vercel/geistdocs` and align the supported Fumadocs and Next.js dependencies for the package version you are adopting.
47
+ Add `@vercel/geistdocs` and align the supported Fumadocs and Next.js dependencies for the package version you are adopting. Geistdocs requires Next.js 16.3.3 or later within 16.x. Earlier 16.3 releases can retain an optional catch-all route's index content after a client navigation to a child page when Cache Components and Partial Prefetching are enabled.
48
48
 
49
49
  For an existing project, use your package manager directly:
50
50
 
@@ -15,7 +15,9 @@ related:
15
15
 
16
16
  Geistdocs supports MDX, a superset of Markdown that allows you to use JSX components within your documentation. This guide covers all the formatting options available.
17
17
 
18
- Help me write a Geistdocs MDX page. Use this page as a syntax reference and create an example page with frontmatter, headings, links, a code block, a `Callout`, and a `CopyPrompt` component.
18
+ Help me write a Geistdocs MDX page. Use this page as a syntax reference and
19
+ create an example page with frontmatter, headings, links, a code block, a
20
+ `Callout`, and a `CopyPrompt` component.
19
21
 
20
22
  ## Frontmatter
21
23
 
@@ -67,11 +69,17 @@ Headings automatically generate anchor links for navigation and deep linking.
67
69
 
68
70
  Create unordered lists with `-`, `*`, or `+`:
69
71
 
70
- - First item
71
- - Second item
72
- - Nested item
73
- - Another nested item
74
- - Third item
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
75
83
 
76
84
  Create ordered lists with numbers:
77
85
 
@@ -83,7 +91,64 @@ Create ordered lists with numbers:
83
91
 
84
92
  Use `>` to create blockquotes:
85
93
 
86
- > This is a blockquote. You can use it to highlight important information or quotes from external sources.
94
+ > **Watch:** Learn more about how to use `next/image` → [YouTube (9 minutes)](https://youtu.be/IU_qq_c_lKA).
95
+
96
+ ### Callouts
97
+
98
+ Use `<Callout>` for a highlighted informational note:
99
+
100
+ ```mdx
101
+ <Callout>This is automatically set when deploying to Vercel.</Callout>
102
+ ```
103
+
104
+ This renders as:
105
+
106
+ > This is automatically set when deploying to Vercel.
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.
87
152
 
88
153
  ### Links
89
154
 
@@ -92,6 +157,15 @@ Create links with `[text](url)`:
92
157
  - [External link](https://vercel.com)
93
158
  - [Internal link](/docs/getting-started)
94
159
 
160
+ Use an absolute `https://` or `http://` URL to mark a link as external. External
161
+ links open outside the docs site and display an arrow icon. Use a root-relative
162
+ path beginning with `/` for internal links:
163
+
164
+ ```md
165
+ [External link](https://vercel.com)
166
+ [Internal link](/docs/getting-started)
167
+ ```
168
+
95
169
  ### Images
96
170
 
97
171
  Add images with `![alt text](url)`:
@@ -124,6 +198,16 @@ This renders as:
124
198
  | GFM | GitHub extensions | Supported |
125
199
  | MDX | JSX in Markdown | Supported |
126
200
 
201
+ Tables can also include inline code, as commonly used for file references:
202
+
203
+ | File | Description |
204
+ | -------------------- | ------------------------------------------------ |
205
+ | `next.config.js` | Configuration file for Next.js |
206
+ | `package.json` | Project dependencies and scripts |
207
+ | `instrumentation.ts` | OpenTelemetry and instrumentation file |
208
+ | `.env.local` | Local environment variables |
209
+ | `tsconfig.json` | Configuration file for TypeScript |
210
+
127
211
  ### Task Lists
128
212
 
129
213
  Create interactive task lists:
@@ -196,6 +280,78 @@ export const Button = ({ children }) => {
196
280
  };
197
281
  ```
198
282
 
283
+ ### Tabs and switchers
284
+
285
+ Use consecutive fences with `tab` metadata for code tabs that expose every
286
+ option at once:
287
+
288
+ ````md
289
+ ```ts tab="TypeScript" title="example.ts"
290
+ export const greeting: string = "Hello from TypeScript";
291
+ ```
292
+
293
+ ```js tab="JavaScript" title="example.js"
294
+ export const greeting = "Hello from JavaScript";
295
+ ```
296
+ ````
297
+
298
+ This renders as:
299
+
300
+ ```ts tab="TypeScript" title="example.ts"
301
+ export const greeting: string = "Hello from TypeScript";
302
+ ```
303
+
304
+ ```js tab="JavaScript" title="example.js"
305
+ export const greeting = "Hello from JavaScript";
306
+ ```
307
+
308
+ Wrap the same fences in `<CodeBlockTabs compact>` to move the selector into the
309
+ code-block header:
310
+
311
+ ````mdx
312
+ <CompactCodeBlockTabs defaultValue="TypeScript">
313
+ <CodeBlockTabsList>
314
+ <CodeBlockTabsTrigger value="TypeScript">TypeScript</CodeBlockTabsTrigger>
315
+ <CodeBlockTabsTrigger value="JavaScript">JavaScript</CodeBlockTabsTrigger>
316
+ </CodeBlockTabsList>
317
+ <CodeBlockTab value="TypeScript">
318
+ ```ts title="example.ts"
319
+ export const greeting: string = "Hello from TypeScript";
320
+ ```
321
+ </CodeBlockTab>
322
+ <CodeBlockTab value="JavaScript">
323
+ ```js title="example.js"
324
+ export const greeting = "Hello from JavaScript";
325
+ ```
326
+ </CodeBlockTab>
327
+ </CompactCodeBlockTabs>
328
+ ````
329
+
330
+ This renders as:
331
+
332
+ <CompactCodeBlockTabs defaultValue="TypeScript">
333
+ <CodeBlockTabsList>
334
+ <CodeBlockTabsTrigger value="TypeScript">TypeScript</CodeBlockTabsTrigger>
335
+ <CodeBlockTabsTrigger value="JavaScript">JavaScript</CodeBlockTabsTrigger>
336
+ </CodeBlockTabsList>
337
+ <CodeBlockTab value="TypeScript">
338
+ ```ts title="example.ts"
339
+ export const greeting: string = "Hello from TypeScript";
340
+ ```
341
+ </CodeBlockTab>
342
+ <CodeBlockTab value="JavaScript">
343
+ ```js title="example.js"
344
+ export const greeting = "Hello from JavaScript";
345
+ ```
346
+ </CodeBlockTab>
347
+ </CompactCodeBlockTabs>
348
+
349
+ When migrating an existing site such as next-site, translate adjacent
350
+ `switcher` fences to `tab="TypeScript"` and `tab="JavaScript"`, then wrap the
351
+ pair with `<CodeBlockTabs compact>`. Import `@vercel/geistdocs/styles.css` (or
352
+ `theme.css` with the documented Geist dependencies) so Tailwind scans the
353
+ package's compiled components and emits the tab layout utilities.
354
+
199
355
  ### Framework icons
200
356
 
201
357
  Append `#<framework>` to the title to show a framework logo instead of the
@@ -204,22 +360,22 @@ values are `#next` / `#nextjs` and `#svelte` / `#sveltekit`:
204
360
 
205
361
  ````md
206
362
  ```ts title="flags.ts#next"
207
- import { flag } from 'flags/next';
363
+ import { flag } from "flags/next";
208
364
  ```
209
365
 
210
366
  ```ts title="flags.ts#svelte"
211
- import { flag } from 'flags/sveltekit';
367
+ import { flag } from "flags/sveltekit";
212
368
  ```
213
369
  ````
214
370
 
215
371
  This renders as:
216
372
 
217
373
  ```ts title="flags.ts#next"
218
- import { flag } from 'flags/next';
374
+ import { flag } from "flags/next";
219
375
  ```
220
376
 
221
377
  ```ts title="flags.ts#svelte"
222
- import { flag } from 'flags/sveltekit';
378
+ import { flag } from "flags/sveltekit";
223
379
  ```
224
380
 
225
381
  ### Line Numbers
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@vercel/geistdocs",
3
3
  "description": "Runtime and CLI for Geistdocs projects.",
4
- "version": "1.25.1-canary.9556d32",
4
+ "version": "1.25.1-canary.b6fcbed",
5
5
  "license": "Apache-2.0",
6
6
  "repository": {
7
7
  "type": "git",
@@ -224,7 +224,7 @@
224
224
  "zod": "^4.1.13"
225
225
  },
226
226
  "peerDependencies": {
227
- "next": "^16.3.0",
227
+ "next": "^16.3.3",
228
228
  "react": "^19.2.3",
229
229
  "react-dom": "^19.2.3",
230
230
  "tailwindcss": "^4.1.17"
@@ -238,7 +238,7 @@
238
238
  "@types/react": "^19.2.7",
239
239
  "@types/react-dom": "^19.2.3",
240
240
  "mdast-util-mdx-jsx": "^3.2.0",
241
- "next": "16.3.1",
241
+ "next": "16.3.3",
242
242
  "react": "^19.2.3",
243
243
  "react-dom": "^19.2.3",
244
244
  "tsup": "^8.5.1",
@@ -45,7 +45,7 @@
45
45
 
46
46
  /* TOC and footer links use gray-1000 */
47
47
  #nd-toc {
48
- @apply text-gray-1000 md:pl-6;
48
+ @apply text-gray-1000;
49
49
  }
50
50
 
51
51
  #nd-toc a {
@@ -42,7 +42,7 @@ Fix unrelated build failures first. A migration is safer when the starting point
42
42
 
43
43
  ## Install Geistdocs
44
44
 
45
- Add `@vercel/geistdocs` and align the supported Fumadocs and Next.js dependencies for the package version you are adopting.
45
+ Add `@vercel/geistdocs` and align the supported Fumadocs and Next.js dependencies for the package version you are adopting. Geistdocs requires Next.js 16.3.3 or later within 16.x. Earlier 16.3 releases can retain an optional catch-all route's index content after a client navigation to a child page when Cache Components and Partial Prefetching are enabled.
46
46
 
47
47
  For an existing project, use your package manager directly:
48
48