@depup/nextra 4.6.1-depup.0

package/dist/server/schemas.d.ts

@@ -0,0 +1,352 @@
+import * as react from 'react';
+import { ReactElement, ReactNode } from 'react';
+import { PluggableList } from './lib/index.js';
+import * as rehype_katex_lib_index_js from 'rehype-katex/lib/index.js';
+import { MathJax3Config } from 'better-react-mathjax';
+import { Options } from 'rehype-pretty-code';
+import { z } from 'zod';
+
+declare const MathJaxOptionsSchema: z.ZodObject<{
+    src: z.ZodOptional<z.ZodString>;
+    config: z.ZodOptional<z.ZodCustom<MathJax3Config, MathJax3Config>>;
+}, z.core.$strict>;
+declare const NextraConfigSchema: z.ZodObject<{
+    defaultShowCopyCode: z.ZodOptional<z.ZodBoolean>;
+    search: z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodObject<{
+        codeblocks: z.ZodBoolean;
+    }, z.core.$strict>]>>;
+    staticImage: z.ZodDefault<z.ZodBoolean>;
+    readingTime: z.ZodOptional<z.ZodBoolean>;
+    latex: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodObject<{
+        renderer: z.ZodLiteral<"mathjax">;
+        options: z.ZodOptional<z.ZodObject<{
+            src: z.ZodOptional<z.ZodString>;
+            config: z.ZodOptional<z.ZodCustom<MathJax3Config, MathJax3Config>>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>, z.ZodObject<{
+        renderer: z.ZodLiteral<"katex">;
+        options: z.ZodCustom<rehype_katex_lib_index_js.Options, rehype_katex_lib_index_js.Options>;
+    }, z.core.$strict>]>>;
+    codeHighlight: z.ZodDefault<z.ZodBoolean>;
+    mdxOptions: z.ZodDefault<z.ZodObject<{
+        rehypePlugins: z.ZodOptional<z.ZodCustom<PluggableList | null | undefined, PluggableList | null | undefined>>;
+        remarkPlugins: z.ZodOptional<z.ZodCustom<PluggableList | null | undefined, PluggableList | null | undefined>>;
+        recmaPlugins: z.ZodOptional<z.ZodCustom<PluggableList | null | undefined, PluggableList | null | undefined>>;
+        format: z.ZodDefault<z.ZodEnum<{
+            detect: "detect";
+            mdx: "mdx";
+            md: "md";
+        }>>;
+        rehypePrettyCodeOptions: z.ZodDefault<z.ZodCustom<Options, Options>>;
+    }, z.core.$strict>>;
+    whiteListTagsStyling: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    contentDirBasePath: z.ZodDefault<z.ZodString>;
+    unstable_shouldAddLocaleToLinks: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strict>;
+declare const element: z.ZodCustom<ReactElement<unknown, string | react.JSXElementConstructor<any>>, ReactElement<unknown, string | react.JSXElementConstructor<any>>>;
+/**
+ * https://react.dev/reference/react/isValidElement#react-elements-vs-react-nodes
+ */
+declare const reactNode: z.ZodCustom<ReactNode, ReactNode>;
+declare const pageThemeSchema: z.ZodObject<{
+    breadcrumb: z.ZodOptional<z.ZodBoolean>;
+    collapsed: z.ZodOptional<z.ZodBoolean>;
+    copyPage: z.ZodOptional<z.ZodBoolean>;
+    footer: z.ZodOptional<z.ZodBoolean>;
+    layout: z.ZodOptional<z.ZodLiteral<"default" | "full">>;
+    navbar: z.ZodOptional<z.ZodBoolean>;
+    pagination: z.ZodOptional<z.ZodBoolean>;
+    sidebar: z.ZodOptional<z.ZodBoolean>;
+    timestamp: z.ZodOptional<z.ZodBoolean>;
+    toc: z.ZodOptional<z.ZodBoolean>;
+    typesetting: z.ZodOptional<z.ZodLiteral<"default" | "article">>;
+}, z.core.$strict>;
+declare const separatorItemSchema: z.ZodObject<{
+    type: z.ZodLiteral<"separator">;
+    title: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodCustom<ReactElement<unknown, string | react.JSXElementConstructor<any>>, ReactElement<unknown, string | react.JSXElementConstructor<any>>>]>>;
+}, z.core.$strict>;
+declare const menuSchema: z.ZodObject<{
+    type: z.ZodLiteral<"menu">;
+    title: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodCustom<ReactElement<unknown, string | react.JSXElementConstructor<any>>, ReactElement<unknown, string | react.JSXElementConstructor<any>>>]>>;
+    items: z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodCustom<ReactElement<unknown, string | react.JSXElementConstructor<any>>, ReactElement<unknown, string | react.JSXElementConstructor<any>>>]>, z.ZodObject<{
+        title: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodCustom<ReactElement<unknown, string | react.JSXElementConstructor<any>>, ReactElement<unknown, string | react.JSXElementConstructor<any>>>]>>;
+        href: z.ZodString;
+    }, z.core.$strict>, z.ZodObject<{
+        title: z.ZodUnion<readonly [z.ZodString, z.ZodCustom<ReactElement<unknown, string | react.JSXElementConstructor<any>>, ReactElement<unknown, string | react.JSXElementConstructor<any>>>]>;
+    }, z.core.$strict>, z.ZodObject<{
+        type: z.ZodLiteral<"separator">;
+        title: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodCustom<ReactElement<unknown, string | react.JSXElementConstructor<any>>, ReactElement<unknown, string | react.JSXElementConstructor<any>>>]>>;
+    }, z.core.$strict>]>, z.ZodTransform<string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | {
+        href: string;
+        title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+    } | {
+        type: "separator";
+        title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+    } | {
+        title: string | ReactElement<unknown, string | react.JSXElementConstructor<any>>;
+    } | {
+        title: ((string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | {
+            href: string;
+            title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+        } | {
+            type: "separator";
+            title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+        } | {
+            title: string | ReactElement<unknown, string | react.JSXElementConstructor<any>>;
+        }) & string) | ((string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | {
+            href: string;
+            title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+        } | {
+            type: "separator";
+            title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+        } | {
+            title: string | ReactElement<unknown, string | react.JSXElementConstructor<any>>;
+        }) & ReactElement<unknown, string | react.JSXElementConstructor<any>>);
+    }, string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | {
+        href: string;
+        title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+    } | {
+        type: "separator";
+        title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+    } | {
+        title: string | ReactElement<unknown, string | react.JSXElementConstructor<any>>;
+    }>>>, z.ZodTransform<Record<string, string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | {
+        href: string;
+        title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+    } | {
+        type: "separator";
+        title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+    } | {
+        title: string | ReactElement<unknown, string | react.JSXElementConstructor<any>>;
+    } | {
+        title: ((string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | {
+            href: string;
+            title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+        } | {
+            type: "separator";
+            title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+        } | {
+            title: string | ReactElement<unknown, string | react.JSXElementConstructor<any>>;
+        }) & string) | ((string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | {
+            href: string;
+            title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+        } | {
+            type: "separator";
+            title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+        } | {
+            title: string | ReactElement<unknown, string | react.JSXElementConstructor<any>>;
+        }) & ReactElement<unknown, string | react.JSXElementConstructor<any>>);
+    }>, Record<string, string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | {
+        href: string;
+        title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+    } | {
+        type: "separator";
+        title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+    } | {
+        title: string | ReactElement<unknown, string | react.JSXElementConstructor<any>>;
+    } | {
+        title: ((string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | {
+            href: string;
+            title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+        } | {
+            type: "separator";
+            title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+        } | {
+            title: string | ReactElement<unknown, string | react.JSXElementConstructor<any>>;
+        }) & string) | ((string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | {
+            href: string;
+            title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+        } | {
+            type: "separator";
+            title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+        } | {
+            title: string | ReactElement<unknown, string | react.JSXElementConstructor<any>>;
+        }) & ReactElement<unknown, string | react.JSXElementConstructor<any>>);
+    }>>>;
+    display: z.ZodOptional<z.ZodEnum<{
+        normal: "normal";
+        hidden: "hidden";
+    }>>;
+}, z.core.$strict>;
+declare const itemSchema: z.ZodObject<{
+    type: z.ZodOptional<z.ZodEnum<{
+        page: "page";
+        doc: "doc";
+    }>>;
+    title: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodCustom<ReactElement<unknown, string | react.JSXElementConstructor<any>>, ReactElement<unknown, string | react.JSXElementConstructor<any>>>]>>;
+    /**
+     * An option to control how an item should be displayed in the sidebar:
+     * - `normal`: the default behavior, item will be displayed
+     * - `hidden`: the item will not be displayed in the sidebar entirely
+     * - `children`: if the item is a folder, itself will be hidden but all its children will still be processed
+     */
+    display: z.ZodOptional<z.ZodEnum<{
+        normal: "normal";
+        hidden: "hidden";
+        children: "children";
+    }>>;
+    theme: z.ZodOptional<z.ZodObject<{
+        breadcrumb: z.ZodOptional<z.ZodBoolean>;
+        collapsed: z.ZodOptional<z.ZodBoolean>;
+        copyPage: z.ZodOptional<z.ZodBoolean>;
+        footer: z.ZodOptional<z.ZodBoolean>;
+        layout: z.ZodOptional<z.ZodLiteral<"default" | "full">>;
+        navbar: z.ZodOptional<z.ZodBoolean>;
+        pagination: z.ZodOptional<z.ZodBoolean>;
+        sidebar: z.ZodOptional<z.ZodBoolean>;
+        timestamp: z.ZodOptional<z.ZodBoolean>;
+        toc: z.ZodOptional<z.ZodBoolean>;
+        typesetting: z.ZodOptional<z.ZodLiteral<"default" | "article">>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+declare const metaSchema: z.ZodUnion<readonly [z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodCustom<ReactElement<unknown, string | react.JSXElementConstructor<any>>, ReactElement<unknown, string | react.JSXElementConstructor<any>>>]>, z.ZodTransform<string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | {
+    title: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | (ReactElement<unknown, string | react.JSXElementConstructor<any>> & string) | (string & ReactElement<unknown, string | react.JSXElementConstructor<any>>);
+}, string | ReactElement<unknown, string | react.JSXElementConstructor<any>>>>, z.ZodObject<{
+    type: z.ZodOptional<z.ZodEnum<{
+        page: "page";
+        doc: "doc";
+    }>>;
+    title: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodCustom<ReactElement<unknown, string | react.JSXElementConstructor<any>>, ReactElement<unknown, string | react.JSXElementConstructor<any>>>]>>;
+    /**
+     * An option to control how an item should be displayed in the sidebar:
+     * - `normal`: the default behavior, item will be displayed
+     * - `hidden`: the item will not be displayed in the sidebar entirely
+     * - `children`: if the item is a folder, itself will be hidden but all its children will still be processed
+     */
+    display: z.ZodOptional<z.ZodEnum<{
+        normal: "normal";
+        hidden: "hidden";
+        children: "children";
+    }>>;
+    theme: z.ZodOptional<z.ZodObject<{
+        breadcrumb: z.ZodOptional<z.ZodBoolean>;
+        collapsed: z.ZodOptional<z.ZodBoolean>;
+        copyPage: z.ZodOptional<z.ZodBoolean>;
+        footer: z.ZodOptional<z.ZodBoolean>;
+        layout: z.ZodOptional<z.ZodLiteral<"default" | "full">>;
+        navbar: z.ZodOptional<z.ZodBoolean>;
+        pagination: z.ZodOptional<z.ZodBoolean>;
+        sidebar: z.ZodOptional<z.ZodBoolean>;
+        timestamp: z.ZodOptional<z.ZodBoolean>;
+        toc: z.ZodOptional<z.ZodBoolean>;
+        typesetting: z.ZodOptional<z.ZodLiteral<"default" | "article">>;
+    }, z.core.$strict>>;
+}, z.core.$strict>, z.ZodObject<{
+    title: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodCustom<ReactElement<unknown, string | react.JSXElementConstructor<any>>, ReactElement<unknown, string | react.JSXElementConstructor<any>>>]>>;
+    href: z.ZodString;
+    type: z.ZodOptional<z.ZodEnum<{
+        page: "page";
+        doc: "doc";
+    }>>;
+    display: z.ZodOptional<z.ZodEnum<{
+        normal: "normal";
+        hidden: "hidden";
+    }>>;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"separator">;
+    title: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodCustom<ReactElement<unknown, string | react.JSXElementConstructor<any>>, ReactElement<unknown, string | react.JSXElementConstructor<any>>>]>>;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"menu">;
+    title: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodCustom<ReactElement<unknown, string | react.JSXElementConstructor<any>>, ReactElement<unknown, string | react.JSXElementConstructor<any>>>]>>;
+    items: z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodCustom<ReactElement<unknown, string | react.JSXElementConstructor<any>>, ReactElement<unknown, string | react.JSXElementConstructor<any>>>]>, z.ZodObject<{
+        title: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodCustom<ReactElement<unknown, string | react.JSXElementConstructor<any>>, ReactElement<unknown, string | react.JSXElementConstructor<any>>>]>>;
+        href: z.ZodString;
+    }, z.core.$strict>, z.ZodObject<{
+        title: z.ZodUnion<readonly [z.ZodString, z.ZodCustom<ReactElement<unknown, string | react.JSXElementConstructor<any>>, ReactElement<unknown, string | react.JSXElementConstructor<any>>>]>;
+    }, z.core.$strict>, z.ZodObject<{
+        type: z.ZodLiteral<"separator">;
+        title: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodCustom<ReactElement<unknown, string | react.JSXElementConstructor<any>>, ReactElement<unknown, string | react.JSXElementConstructor<any>>>]>>;
+    }, z.core.$strict>]>, z.ZodTransform<string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | {
+        href: string;
+        title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+    } | {
+        type: "separator";
+        title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+    } | {
+        title: string | ReactElement<unknown, string | react.JSXElementConstructor<any>>;
+    } | {
+        title: ((string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | {
+            href: string;
+            title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+        } | {
+            type: "separator";
+            title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+        } | {
+            title: string | ReactElement<unknown, string | react.JSXElementConstructor<any>>;
+        }) & string) | ((string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | {
+            href: string;
+            title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+        } | {
+            type: "separator";
+            title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+        } | {
+            title: string | ReactElement<unknown, string | react.JSXElementConstructor<any>>;
+        }) & ReactElement<unknown, string | react.JSXElementConstructor<any>>);
+    }, string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | {
+        href: string;
+        title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+    } | {
+        type: "separator";
+        title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+    } | {
+        title: string | ReactElement<unknown, string | react.JSXElementConstructor<any>>;
+    }>>>, z.ZodTransform<Record<string, string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | {
+        href: string;
+        title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+    } | {
+        type: "separator";
+        title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+    } | {
+        title: string | ReactElement<unknown, string | react.JSXElementConstructor<any>>;
+    } | {
+        title: ((string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | {
+            href: string;
+            title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+        } | {
+            type: "separator";
+            title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+        } | {
+            title: string | ReactElement<unknown, string | react.JSXElementConstructor<any>>;
+        }) & string) | ((string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | {
+            href: string;
+            title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+        } | {
+            type: "separator";
+            title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+        } | {
+            title: string | ReactElement<unknown, string | react.JSXElementConstructor<any>>;
+        }) & ReactElement<unknown, string | react.JSXElementConstructor<any>>);
+    }>, Record<string, string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | {
+        href: string;
+        title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+    } | {
+        type: "separator";
+        title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+    } | {
+        title: string | ReactElement<unknown, string | react.JSXElementConstructor<any>>;
+    } | {
+        title: ((string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | {
+            href: string;
+            title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+        } | {
+            type: "separator";
+            title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+        } | {
+            title: string | ReactElement<unknown, string | react.JSXElementConstructor<any>>;
+        }) & string) | ((string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | {
+            href: string;
+            title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+        } | {
+            type: "separator";
+            title?: string | ReactElement<unknown, string | react.JSXElementConstructor<any>> | undefined;
+        } | {
+            title: string | ReactElement<unknown, string | react.JSXElementConstructor<any>>;
+        }) & ReactElement<unknown, string | react.JSXElementConstructor<any>>);
+    }>>>;
+    display: z.ZodOptional<z.ZodEnum<{
+        normal: "normal";
+        hidden: "hidden";
+    }>>;
+}, z.core.$strict>]>;
+
+export { MathJaxOptionsSchema, NextraConfigSchema, element, itemSchema, menuSchema, metaSchema, pageThemeSchema, reactNode, separatorItemSchema };

package/dist/server/schemas.js

@@ -0,0 +1,240 @@
+import { isValidElement } from "react";
+import { z } from "zod";
+import { pageTitleFromFilename } from "./utils.js";
+const MathJaxOptionsSchema = z.strictObject({
+  src: z.string().optional().meta({
+    description: "URL for MathJax.",
+    default: '"https://cdnjs.cloudflare.com"'
+  }),
+  config: z.custom().optional().meta({
+    description: "MathJax config. See [configuring MathJax](https://docs.mathjax.org/en/latest/options/index.html).",
+    type: 'import("better-react-mathjax").MathJax3Config'
+  })
+});
+const MdxOptionsSchema = z.strictObject({
+  rehypePlugins: z.custom().optional().meta({
+    description: "List of rehype plugins.",
+    type: 'import("@mdx-js/mdx").ProcessorOptions["rehypePlugins"]'
+  }),
+  remarkPlugins: z.custom().optional().meta({
+    description: "List of remark plugins.",
+    type: 'import("@mdx-js/mdx").ProcessorOptions["remarkPlugins"]'
+  }),
+  recmaPlugins: z.custom().optional().meta({
+    description: "List of recma plugins. This is a new ecosystem, currently in beta, to transform esast trees (JavaScript).",
+    type: 'import("@mdx-js/mdx").ProcessorOptions["recmaPlugins"]'
+  }),
+  format: z.enum(["detect", "mdx", "md"]).default("detect").meta({
+    description: `Format of the file.
+- \`'md'\` means treat as markdown
+- \`'mdx'\` means treat as MDX
+- \`'detect'\` means try to detect the format based on file path.`
+  }),
+  rehypePrettyCodeOptions: z.custom().default({}).meta({
+    description: `Configuration options for [Rehype Pretty Code](https://github.com/rehype-pretty/rehype-pretty-code).
+@remarks \`RehypePrettyCodeOptions\``,
+    type: 'import("rehype-pretty-code").Options'
+  })
+});
+const NextraConfigSchema = z.strictObject({
+  defaultShowCopyCode: z.boolean().optional().meta({
+    description: `Enable the copy button for all code blocks by default, without needing to set \`copy=true\` attribute in the code block metadata.
+> [!TIP]
+>
+> You could still disable the button for specific blocks using \`copy=false\` attribute.`
+  }),
+  search: z.union([
+    z.boolean(),
+    z.strictObject({
+      codeblocks: z.boolean().meta({
+        description: "Whether to index code blocks."
+      })
+    })
+  ]).default({ codeblocks: false }).meta({
+    description: `Option to enable search functionality. When enabled, it sets the \`data-pagefind-body\` attribute on the \`<main>\` element.
+> [!TIP]
+>
+> When set to \`codeblocks: false\`, it adds the \`data-pagefind-ignore="all"\` attribute to all code blocks (\`<pre>\` elements).`
+  }),
+  staticImage: z.boolean().default(true).meta({
+    description: `Option to automatically optimizing your static image imports with the Markdown syntax.
+> [!TIP]
+>
+> Example: \`![Hello](/demo.png)\`.`
+  }),
+  readingTime: z.boolean().optional().meta({
+    description: `Adds estimated reading time of \`.md\` and \`.mdx\` files using [readingTime](https://npmjs.com/package/reading-time) package.
+> [!TIP]
+>
+> The reading time is added to the front matter under the \`readingTime\` key.`
+  }),
+  latex: z.union([
+    z.boolean(),
+    z.strictObject({
+      renderer: z.literal("mathjax"),
+      options: MathJaxOptionsSchema.optional()
+    }),
+    z.strictObject({
+      renderer: z.literal("katex"),
+      options: z.custom().meta({
+        description: "KaTeX options. See https://katex.org/docs/options.html.",
+        type: 'import("rehype-katex").Options'
+      })
+    })
+  ]).optional().meta({
+    description: "Enable LaTeX either with [KaTeX](https://katex.org) to pre-render LaTeX expressions directly in MDX or [MathJax](https://mathjax.org) to dynamically render math in the browser."
+  }),
+  codeHighlight: z.boolean().default(true).meta({
+    description: "Enable or disable syntax highlighting."
+  }),
+  mdxOptions: MdxOptionsSchema.default(MdxOptionsSchema.parse({})).meta({
+    description: `Options specific to MDX compiling.
+@remarks \`MdxOptions\``
+  }),
+  whiteListTagsStyling: z.array(z.string()).optional().meta({
+    description: `Allows you to whitelist HTML elements to be replaced with components defined in the \`mdx-components.js\` file.
+> [!TIP]
+>
+> By default, Nextra only replaces \`<details>\` and \`<summary>\` elements.`
+  }),
+  contentDirBasePath: z.string().startsWith("/").refine((value) => value.length === 1 || !value.endsWith("/"), {
+    error: 'Must not end with "/"'
+  }).default("/").meta({
+    description: "Option to serve your `.md` and `.mdx` files from the `content` directory at a custom path instead of the root (`/`)."
+  }),
+  unstable_shouldAddLocaleToLinks: z.boolean().default(false).meta({
+    description: "Prefixes locale to all links in the page map information. Useful for i18n when you don't want to use Nextra's `middleware` function."
+  })
+});
+const element = z.custom(
+  function checkReactElement(data) {
+    return isValidElement(data);
+  },
+  { error: "Must be a valid React element" }
+);
+const reactNode = z.custom(
+  function checkReactNode(data) {
+    if (
+      // Check if it's a valid React element
+      isValidElement(data) || // Check if it's null or undefined
+      data == null || typeof data === "string" || typeof data === "number" || typeof data === "boolean"
+    ) {
+      return true;
+    }
+    if (Array.isArray(data)) {
+      return data.every((item) => checkReactNode(item));
+    }
+    const isServerComponent = typeof data === "object" && "$$typeof" in data && data.$$typeof === Symbol.for("react.lazy");
+    return isServerComponent;
+  },
+  { error: "Must be a valid React node" }
+);
+const stringOrElement = z.union([z.string(), element]);
+const pageThemeSchema = z.strictObject({
+  breadcrumb: z.boolean().optional().meta({
+    description: "Show or hide breadcrumb navigation.",
+    default: true
+  }),
+  collapsed: z.boolean().optional().meta({
+    description: "Indicates whether the item in sidebar is collapsed by default.",
+    default: false
+  }),
+  copyPage: z.boolean().optional().meta({
+    description: "Specifies whether to display the copy page button.",
+    default: true
+  }),
+  footer: z.boolean().optional().meta({
+    description: "Specifies whether to display the footer.",
+    default: true
+  }),
+  layout: z.literal(["default", "full"]).optional().meta({
+    description: "Defines the layout style.",
+    default: "'default'"
+  }),
+  navbar: z.boolean().optional().meta({
+    description: "Specifies whether to display the navbar.",
+    default: true
+  }),
+  pagination: z.boolean().optional().meta({
+    description: "Determines if pagination controls are shown.",
+    default: true
+  }),
+  sidebar: z.boolean().optional().meta({
+    description: "Specifies whether to display the sidebar.",
+    default: true
+  }),
+  timestamp: z.boolean().optional().meta({
+    description: 'Indicates if "last updated" timestamps are displayed.',
+    default: true
+  }),
+  toc: z.boolean().optional().meta({
+    description: "Determines whether a table of contents is displayed.",
+    default: true
+  }),
+  typesetting: z.literal(["default", "article"]).optional().meta({
+    description: "Configures the text typesetting style.",
+    default: "'default'"
+  })
+});
+const title = stringOrElement.optional();
+const linkSchema = z.strictObject({
+  title,
+  href: z.string()
+});
+const separatorItemSchema = z.strictObject({
+  type: z.literal("separator"),
+  title
+});
+const menuItemSchema = z.union([
+  stringOrElement,
+  linkSchema,
+  z.strictObject({ title: stringOrElement }),
+  separatorItemSchema
+]).transform(transformTitle);
+const menuSchema = z.strictObject({
+  type: z.literal("menu"),
+  title,
+  items: z.record(z.string(), menuItemSchema).transform((obj) => {
+    for (const key in obj) {
+      obj[key].title ||= pageTitleFromFilename(key);
+    }
+    return obj;
+  }),
+  display: z.enum(["normal", "hidden"]).optional()
+});
+const itemSchema = z.strictObject({
+  type: z.enum(["page", "doc"]).optional(),
+  title,
+  /**
+   * An option to control how an item should be displayed in the sidebar:
+   * - `normal`: the default behavior, item will be displayed
+   * - `hidden`: the item will not be displayed in the sidebar entirely
+   * - `children`: if the item is a folder, itself will be hidden but all its children will still be processed
+   */
+  display: z.enum(["normal", "hidden", "children"]).optional(),
+  theme: pageThemeSchema.optional()
+});
+const metaSchema = z.union([
+  stringOrElement.transform(transformTitle),
+  itemSchema,
+  linkSchema.extend({
+    type: z.enum(["page", "doc"]).optional(),
+    display: z.enum(["normal", "hidden"]).optional()
+  }),
+  separatorItemSchema,
+  menuSchema
+]);
+function transformTitle(title2) {
+  return typeof title2 === "string" || isValidElement(title2) ? { title: title2 } : title2;
+}
+export {
+  MathJaxOptionsSchema,
+  NextraConfigSchema,
+  element,
+  itemSchema,
+  menuSchema,
+  metaSchema,
+  pageThemeSchema,
+  reactNode,
+  separatorItemSchema
+};

package/dist/server/tsdoc/base.d.ts

@@ -0,0 +1,38 @@
+import { BaseArgs, GeneratedDefinition, GeneratedType, GeneratedFunction } from './types.js';
+
+/**
+ * Generate documentation for properties of `type` and `interface` and parameters and returns
+ * signature of `function`.
+ * @returns Parsed TSDoc definition from TypeScript `type`, `interface` or `function`.
+ * @example
+ * To generate documentation for a `type`, `interface`, or `function`, export it via the `code`
+ * argument.
+ *
+ * ### As a `default` export
+ *
+ * ```mdx
+ * import { generateDefinition, TSDoc } from 'nextra/tsdoc'
+ *
+ * <TSDoc
+ *   definition={generateDefinition({
+ *     code: "export { yourTypeOrFunction as default } from 'your-package'",
+ *   })}
+ * />
+ * ```
+ *
+ * ### As a named export
+ *
+ * ```mdx
+ * import { generateDefinition, TSDoc } from 'nextra/tsdoc'
+ *
+ * <TSDoc
+ *   definition={generateDefinition({
+ *     code: "export { yourTypeOrFunction } from 'your-package'",
+ *     exportName: 'yourTypeOrFunction'
+ *   })}
+ * />
+ * ```
+ */
+declare function generateDefinition({ code, exportName, flattened }: BaseArgs): GeneratedDefinition & (GeneratedType | GeneratedFunction);
+
+export { generateDefinition };