fumadocs-core 16.0.6 → 16.0.8

package/dist/mdx-plugins/rehype-code.d.ts

@@ -0,0 +1,55 @@
+import { Root } from 'hast';
+import { RehypeShikiOptions } from '@shikijs/rehype';
+import { Processor, Transformer } from 'unified';
+import { ShikiTransformer } from 'shiki';
+
+type CodeBlockIcon = {
+    viewBox: string;
+    fill: string;
+    d: string;
+} | string;
+interface IconOptions {
+    shortcuts?: Record<string, string>;
+    extend?: Record<string, CodeBlockIcon>;
+}
+/**
+ * Inject icons to `icon` property (as HTML)
+ */
+declare function transformerIcon(options?: IconOptions): ShikiTransformer;
+
+declare const rehypeCodeDefaultOptions: RehypeCodeOptions;
+type DistributiveOmit<T, K extends keyof T> = T extends unknown ? Omit<T, K> : never;
+type RehypeCodeOptions = DistributiveOmit<RehypeShikiOptions, 'lazy'> & {
+    /**
+     * Load languages and themes on-demand.
+     * @defaultValue true
+     */
+    lazy?: boolean;
+    /**
+     * The regex engine to use.
+     *
+     * @defaultValue 'js'
+     */
+    engine?: 'js' | 'oniguruma';
+    /**
+     * Filter meta string before processing
+     */
+    filterMetaString?: (metaString: string) => string;
+    /**
+     * Add icon to code blocks
+     */
+    icon?: IconOptions | false;
+    /**
+     * Wrap code blocks in `<Tab>` component when "tab" meta string presents
+     *
+     * @defaultValue true
+     */
+    tab?: boolean;
+};
+/**
+ * Handle codeblocks
+ */
+declare function rehypeCode(this: Processor, _options?: Partial<RehypeCodeOptions>): Transformer<Root, Root>;
+declare function transformerTab(): ShikiTransformer;
+
+export { type CodeBlockIcon, type RehypeCodeOptions, rehypeCode, rehypeCodeDefaultOptions, transformerIcon, transformerTab };

package/dist/mdx-plugins/rehype-code.js

@@ -0,0 +1,15 @@
+import {
+  rehypeCode,
+  rehypeCodeDefaultOptions,
+  transformerIcon,
+  transformerTab
+} from "../chunk-X2HFD5QJ.js";
+import "../chunk-TWIDBWFG.js";
+import "../chunk-XN2LKXFZ.js";
+import "../chunk-U67V476Y.js";
+export {
+  rehypeCode,
+  rehypeCodeDefaultOptions,
+  transformerIcon,
+  transformerTab
+};

package/dist/mdx-plugins/rehype-toc.d.ts

@@ -0,0 +1,14 @@
+import { Processor, Transformer } from 'unified';
+import { Root } from 'hast';
+
+interface RehypeTocOptions {
+    /**
+     * Export generated toc as a variable
+     *
+     * @defaultValue true
+     */
+    exportToc?: boolean;
+}
+declare function rehypeToc(this: Processor, { exportToc }?: RehypeTocOptions): Transformer<Root, Root>;
+
+export { type RehypeTocOptions, rehypeToc };

package/dist/mdx-plugins/rehype-toc.js

@@ -0,0 +1,7 @@
+import {
+  rehypeToc
+} from "../chunk-EFVXL2PP.js";
+import "../chunk-U67V476Y.js";
+export {
+  rehypeToc
+};

package/dist/mdx-plugins/remark-admonition.d.ts

@@ -0,0 +1,18 @@
+import { Transformer } from 'unified';
+import { Root } from 'mdast';
+
+interface RemarkAdmonitionOptions {
+    tag?: string;
+    /**
+     * Map type to another type
+     */
+    typeMap?: Record<string, string>;
+}
+/**
+ * Remark Plugin to support Admonition syntax
+ *
+ * Useful when Migrating from Docusaurus
+ */
+declare function remarkAdmonition(options?: RemarkAdmonitionOptions): Transformer<Root, Root>;
+
+export { type RemarkAdmonitionOptions, remarkAdmonition };

package/dist/mdx-plugins/remark-admonition.js

@@ -0,0 +1,8 @@
+import {
+  remarkAdmonition
+} from "../chunk-JOXPHQ2R.js";
+import "../chunk-A4G5V4FQ.js";
+import "../chunk-U67V476Y.js";
+export {
+  remarkAdmonition
+};

package/dist/mdx-plugins/remark-code-tab.d.ts

@@ -0,0 +1,30 @@
+import { Processor, Transformer } from 'unified';
+import { Code, Root } from 'mdast';
+import { MdxJsxFlowElement } from 'mdast-util-mdx-jsx';
+
+type TabType = keyof typeof Types;
+interface RemarkCodeTabOptions {
+    Tabs?: TabType;
+    /**
+     * Parse MDX in tab values
+     *
+     * @defaultValue false
+     */
+    parseMdx?: boolean;
+}
+declare module 'mdast' {
+    interface CodeData {
+        tab?: string;
+    }
+}
+declare const Types: {
+    CodeBlockTabs: {
+        convert(processor: Processor, nodes: Code[], withMdx?: boolean, withParent?: boolean): MdxJsxFlowElement;
+    };
+    Tabs: {
+        convert(processor: Processor, nodes: Code[], withMdx?: boolean, withParent?: boolean): MdxJsxFlowElement;
+    };
+};
+declare function remarkCodeTab(this: Processor, options?: RemarkCodeTabOptions): Transformer<Root, Root>;
+
+export { type RemarkCodeTabOptions, remarkCodeTab };

package/dist/mdx-plugins/remark-code-tab.js

@@ -0,0 +1,8 @@
+import {
+  remarkCodeTab
+} from "../chunk-CH7YHH7V.js";
+import "../chunk-TWIDBWFG.js";
+import "../chunk-U67V476Y.js";
+export {
+  remarkCodeTab
+};

package/dist/mdx-plugins/remark-gfm.d.ts

@@ -0,0 +1 @@
+export { Options as RemarkGfmOptions, default as remarkGfm } from 'remark-gfm';

package/dist/mdx-plugins/remark-gfm.js

@@ -0,0 +1,7 @@
+import {
+  default as default2
+} from "../chunk-ONG4RVCR.js";
+import "../chunk-U67V476Y.js";
+export {
+  default2 as remarkGfm
+};

package/dist/mdx-plugins/remark-heading.d.ts

@@ -0,0 +1,31 @@
+import { Root, Heading } from 'mdast';
+import { Transformer } from 'unified';
+
+declare module 'mdast' {
+    interface HeadingData extends Data {
+        hProperties?: {
+            id?: string;
+        };
+    }
+}
+interface RemarkHeadingOptions {
+    slug?: (root: Root, heading: Heading, text: string) => string;
+    /**
+     * Allow custom headings ids
+     *
+     * @defaultValue true
+     */
+    customId?: boolean;
+    /**
+     * Attach an array of `TOCItemType` to `file.data.toc`
+     *
+     * @defaultValue true
+     */
+    generateToc?: boolean;
+}
+/**
+ * Add heading ids and extract TOC
+ */
+declare function remarkHeading({ slug: defaultSlug, customId, generateToc, }?: RemarkHeadingOptions): Transformer<Root, Root>;
+
+export { type RemarkHeadingOptions, remarkHeading };

package/dist/mdx-plugins/remark-heading.js

@@ -0,0 +1,8 @@
+import {
+  remarkHeading
+} from "../chunk-HNZEUF6C.js";
+import "../chunk-A4G5V4FQ.js";
+import "../chunk-U67V476Y.js";
+export {
+  remarkHeading
+};

package/dist/mdx-plugins/remark-image.d.ts

@@ -0,0 +1,57 @@
+import { Root } from 'mdast';
+import { Transformer } from 'unified';
+
+type ExternalImageOptions = {
+    /**
+     * timeout for fetching remote images (in milliseconds)
+     */
+    timeout?: number;
+} | boolean;
+interface RemarkImageOptions {
+    /**
+     * Directory or base URL to resolve absolute image paths
+     */
+    publicDir?: string;
+    /**
+     * Preferred placeholder type, only available with `useImport` + local images.
+     *
+     * @defaultValue 'blur'
+     */
+    placeholder?: 'blur' | 'none';
+    /**
+     * Define how to handle errors when fetching image size.
+     *
+     * - `error` (default): throw an error.
+     * - `ignore`: do absolutely nothing (Next.js Image component may complain).
+     * - `hide`: remove that image element.
+     *
+     * @defaultValue 'error'
+     */
+    onError?: 'error' | 'hide' | 'ignore' | ((error: Error) => void);
+    /**
+     * Import images in the file, and let bundlers handle it.
+     *
+     * ```tsx
+     * import MyImage from "./public/img.png";
+     *
+     * <img src={MyImage} />
+     * ```
+     *
+     * When disabled, `placeholder` will be ignored.
+     *
+     * @defaultValue true
+     */
+    useImport?: boolean;
+    /**
+     * Fetch image size of external URLs
+     *
+     * @defaultValue true
+     */
+    external?: ExternalImageOptions;
+}
+/**
+ * Turn images into Next.js Image compatible usage.
+ */
+declare function remarkImage({ placeholder, external, useImport, onError, publicDir, }?: RemarkImageOptions): Transformer<Root, Root>;
+
+export { type RemarkImageOptions, remarkImage };

package/dist/mdx-plugins/remark-image.js

@@ -0,0 +1,7 @@
+import {
+  remarkImage
+} from "../chunk-VW3XKOZZ.js";
+import "../chunk-U67V476Y.js";
+export {
+  remarkImage
+};

package/dist/mdx-plugins/remark-mdx-files.d.ts

@@ -0,0 +1,40 @@
+import { Root } from 'mdast';
+import { Transformer } from 'unified';
+import { MdxJsxFlowElement } from 'mdast-util-mdx-jsx';
+
+interface FileNode {
+    depth: number;
+    type: 'file';
+    name: string;
+}
+interface FolderNode {
+    depth: number;
+    type: 'folder';
+    name: string;
+    children: Node[];
+}
+type Node = FileNode | FolderNode;
+interface RemarkMdxFilesOptions {
+    /**
+     * @defaultValue files
+     */
+    lang?: string;
+    toMdx?: (node: Node) => MdxJsxFlowElement;
+}
+/**
+ * Convert codeblocks with `files` as lang, like:
+ *
+ * ```files
+ * project
+ * ├── src
+ * │   ├── index.js
+ * │   └── utils
+ * │       └── helper.js
+ * ├── package.json
+ * ```
+ *
+ * into MDX `<Files />` component
+ */
+declare function remarkMdxFiles(options?: RemarkMdxFilesOptions): Transformer<Root, Root>;
+
+export { type RemarkMdxFilesOptions, remarkMdxFiles };

package/dist/mdx-plugins/remark-mdx-files.js

@@ -0,0 +1,7 @@
+import {
+  remarkMdxFiles
+} from "../chunk-ADBHPKXG.js";
+import "../chunk-U67V476Y.js";
+export {
+  remarkMdxFiles
+};

package/dist/mdx-plugins/remark-mdx-mermaid.d.ts

@@ -0,0 +1,15 @@
+import { Transformer } from 'unified';
+import { Root } from 'mdast';
+
+interface RemarkMdxMermaidOptions {
+    /**
+     * @defaultValue mermaid
+     */
+    lang?: string;
+}
+/**
+ * Convert `mermaid` codeblocks into `<Mermaid />` MDX component
+ */
+declare function remarkMdxMermaid(options?: RemarkMdxMermaidOptions): Transformer<Root, Root>;
+
+export { type RemarkMdxMermaidOptions, remarkMdxMermaid };

package/dist/mdx-plugins/remark-mdx-mermaid.js

@@ -0,0 +1,7 @@
+import {
+  remarkMdxMermaid
+} from "../chunk-FUUVPEA5.js";
+import "../chunk-U67V476Y.js";
+export {
+  remarkMdxMermaid
+};

package/dist/mdx-plugins/remark-npm.d.ts

@@ -0,0 +1,31 @@
+import { Root } from 'mdast';
+import { Transformer } from 'unified';
+
+interface PackageManager {
+    name: string;
+    /**
+     * Default to `name`
+     */
+    value?: string;
+    /**
+     * Convert from npm to another package manager
+     */
+    command: (command: string) => string | undefined;
+}
+interface RemarkNpmOptions {
+    /**
+     * Persist Tab value (Fumadocs UI only)
+     *
+     * @defaultValue false
+     */
+    persist?: {
+        id: string;
+    } | false;
+    packageManagers?: PackageManager[];
+}
+/**
+ * It generates multiple tabs of codeblocks for different package managers from a npm command codeblock.
+ */
+declare function remarkNpm({ persist, packageManagers, }?: RemarkNpmOptions): Transformer<Root, Root>;
+
+export { type RemarkNpmOptions, remarkNpm };

package/dist/mdx-plugins/remark-npm.js

@@ -0,0 +1,8 @@
+import {
+  remarkNpm
+} from "../chunk-GLRQBLGN.js";
+import "../chunk-TWIDBWFG.js";
+import "../chunk-U67V476Y.js";
+export {
+  remarkNpm
+};

package/dist/mdx-plugins/remark-steps.d.ts

@@ -0,0 +1,23 @@
+import { Transformer } from 'unified';
+import { Root } from 'mdast';
+
+interface RemarkStepsOptions {
+    /**
+     * Class name for steps container
+     *
+     * @defaultValue fd-steps
+     */
+    steps?: string;
+    /**
+     * Class name for step container
+     *
+     * @defaultValue fd-step
+     */
+    step?: string;
+}
+/**
+ * Convert headings in the format of `1. Hello World` into steps.
+ */
+declare function remarkSteps({ steps, step, }?: RemarkStepsOptions): Transformer<Root, Root>;
+
+export { type RemarkStepsOptions, remarkSteps };

package/dist/mdx-plugins/remark-steps.js

@@ -0,0 +1,7 @@
+import {
+  remarkSteps
+} from "../chunk-XJ6ZQNEX.js";
+import "../chunk-U67V476Y.js";
+export {
+  remarkSteps
+};

package/dist/{remark-structure-DkCXCzpD.d.ts → mdx-plugins/remark-structure.d.ts}

@@ -31,29 +31,34 @@ interface StructureOptions {
      * - a function that determines if attribute should be indexed.
      */
     allowedMdxAttributes?: string[] | ((node: MdxJsxFlowElement, attribute: MdxJsxAttribute | MdxJsxExpressionAttribute) => boolean);
+    /**
+     * export as `structuredData` or specified variable name.
+     */
+    exportAs?: string | boolean;
 }
 declare module 'mdast' {
     interface Data {
         /**
-         * Get content of unserializable element
-         *
-         * Needed for `remarkStructure` to generate search index
+         * [Fumadocs] Get content of unserializable element, `remarkStructure` uses it to generate search index.
          */
         _string?: string[];
     }
 }
 declare module 'vfile' {
     interface DataMap {
+        /**
+         * [Fumadocs] injected by `remarkStructure`
+         */
         structuredData: StructuredData;
     }
 }
 /**
  * Attach structured data to VFile, you can access via `vfile.data.structuredData`.
  */
-declare function remarkStructure({ types, allowedMdxAttributes, }?: StructureOptions): Transformer<Root, Root>;
+declare function remarkStructure({ types, allowedMdxAttributes, exportAs, }?: StructureOptions): Transformer<Root, Root>;
 /**
  * Extract data from markdown/mdx content
  */
 declare function structure(content: string, remarkPlugins?: PluggableList, options?: StructureOptions): StructuredData;
 
-export { type StructuredData as S, type StructureOptions as a, remarkStructure as r, structure as s };
+export { type StructureOptions, type StructuredData, remarkStructure, structure };

package/dist/mdx-plugins/remark-structure.js

@@ -0,0 +1,10 @@
+import {
+  remarkStructure,
+  structure
+} from "../chunk-SLIKY7GW.js";
+import "../chunk-A4G5V4FQ.js";
+import "../chunk-U67V476Y.js";
+export {
+  remarkStructure,
+  structure
+};

package/dist/search/algolia.d.ts

@@ -1,5 +1,5 @@
 import { Algoliasearch } from 'algoliasearch';
-import { S as StructuredData } from '../remark-structure-DkCXCzpD.js';
+import { StructuredData } from '../mdx-plugins/remark-structure.js';
 import 'mdast';
 import 'unified';
 import 'mdast-util-mdx-jsx';

package/dist/search/client.d.ts

@@ -1,5 +1,5 @@
 import { AnyOrama } from '@orama/orama';
-import '../remark-structure-DkCXCzpD.js';
+import '../mdx-plugins/remark-structure.js';
 import { BaseIndex } from './algolia.js';
 import { LiteClient, SearchResponse } from 'algoliasearch/lite';
 import { OramaCloud, OramaCloudSearchParams } from '@orama/core';

package/dist/search/orama-cloud.d.ts

@@ -1,5 +1,6 @@
-import { S as StructuredData } from '../remark-structure-DkCXCzpD.js';
-import '../remark-code-tab-DmyIyi6m.js';
+import { StructuredData } from '../mdx-plugins/remark-structure.js';
+import '../mdx-plugins/remark-heading.js';
+import '../mdx-plugins/remark-code-tab.js';
 import { OramaCloud } from '@orama/core';
 import 'mdast';
 import 'unified';

package/dist/search/server.d.ts

@@ -1,5 +1,5 @@
 import { TypedDocument, Orama, Language, RawData, create, SearchParams } from '@orama/orama';
-import { S as StructuredData } from '../remark-structure-DkCXCzpD.js';
+import { StructuredData } from '../mdx-plugins/remark-structure.js';
 import { SortedResult } from './index.js';
 export { HighlightedText, ReactSortedResult, createContentHighlighter } from './index.js';
 import { I18nConfig } from '../i18n/index.js';

package/dist/search/server.js

@@ -3,13 +3,13 @@ import {
   searchSimple
 } from "../chunk-XOFXGHS4.js";
 import "../chunk-ZMWYLUDP.js";
+import {
+  createContentHighlighter
+} from "../chunk-OTD7MV33.js";
 import {
   basename,
   extname
 } from "../chunk-XZSI7AHE.js";
-import {
-  createContentHighlighter
-} from "../chunk-OTD7MV33.js";
 import {
   findPath
 } from "../chunk-IZPLHEX4.js";

package/dist/source/index.js

@@ -1,3 +1,6 @@
+import {
+  iconPlugin
+} from "../chunk-FAEPKD7U.js";
 import {
   basename,
   dirname,
@@ -7,9 +10,6 @@ import {
   slash,
   splitPath
 } from "../chunk-XZSI7AHE.js";
-import {
-  iconPlugin
-} from "../chunk-FAEPKD7U.js";
 import {
   normalizeUrl
 } from "../chunk-PFNP6PEB.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-core",
-  "version": "16.0.6",
+  "version": "16.0.8",
   "description": "The library for building a documentation website in any React.js framework",
   "keywords": [
     "Fumadocs",
@@ -72,6 +72,10 @@
       "import": "./dist/mdx-plugins/index.js",
       "types": "./dist/mdx-plugins/index.d.ts"
     },
+    "./mdx-plugins/*": {
+      "import": "./dist/mdx-plugins/*.js",
+      "types": "./dist/mdx-plugins/*.d.ts"
+    },
     "./i18n": {
       "import": "./dist/i18n/index.js",
       "types": "./dist/i18n/index.d.ts"
@@ -105,6 +109,7 @@
     "@orama/orama": "^3.1.16",
     "@shikijs/rehype": "^3.14.0",
     "@shikijs/transformers": "^3.14.0",
+    "estree-util-value-to-estree": "^3.5.0",
     "github-slugger": "^2.0.0",
     "hast-util-to-estree": "^3.1.3",
     "hast-util-to-jsx-runtime": "^2.3.6",
@@ -121,22 +126,22 @@
   },
   "devDependencies": {
     "@mdx-js/mdx": "^3.1.1",
-    "@mixedbread/sdk": "^0.35.1",
+    "@mixedbread/sdk": "^0.38.0",
     "@orama/core": "^1.2.13",
-    "@tanstack/react-router": "^1.133.36",
+    "@tanstack/react-router": "^1.134.12",
     "@types/estree-jsx": "^1.0.5",
     "@types/hast": "^3.0.4",
     "@types/mdast": "^4.0.4",
     "@types/negotiator": "^0.6.4",
-    "@types/node": "24.9.2",
+    "@types/node": "24.10.0",
     "@types/react": "^19.2.2",
     "@types/react-dom": "^19.2.2",
-    "algoliasearch": "5.41.0",
-    "lucide-react": "^0.548.0",
+    "algoliasearch": "5.42.0",
+    "lucide-react": "^0.552.0",
     "mdast-util-mdx-jsx": "^3.2.0",
     "mdast-util-mdxjs-esm": "^2.0.1",
     "next": "16.0.1",
-    "react-router": "^7.9.4",
+    "react-router": "^7.9.5",
     "remark-mdx": "^3.1.1",
     "remove-markdown": "^0.6.2",
     "typescript": "^5.9.3",

package/dist/remark-code-tab-DmyIyi6m.d.ts

@@ -1,57 +0,0 @@
-import { Root, Heading, Code } from 'mdast';
-import { Transformer, Processor } from 'unified';
-import { MdxJsxFlowElement } from 'mdast-util-mdx-jsx';
-
-declare module 'mdast' {
-    interface HeadingData extends Data {
-        hProperties?: {
-            id?: string;
-        };
-    }
-}
-interface RemarkHeadingOptions {
-    slug?: (root: Root, heading: Heading, text: string) => string;
-    /**
-     * Allow custom headings ids
-     *
-     * @defaultValue true
-     */
-    customId?: boolean;
-    /**
-     * Attach an array of `TOCItemType` to `file.data.toc`
-     *
-     * @defaultValue true
-     */
-    generateToc?: boolean;
-}
-/**
- * Add heading ids and extract TOC
- */
-declare function remarkHeading({ slug: defaultSlug, customId, generateToc, }?: RemarkHeadingOptions): Transformer<Root, Root>;
-
-type TabType = keyof typeof Types;
-interface RemarkCodeTabOptions {
-    Tabs?: TabType;
-    /**
-     * Parse MDX in tab values
-     *
-     * @defaultValue false
-     */
-    parseMdx?: boolean;
-}
-declare module 'mdast' {
-    interface CodeData {
-        tab?: string;
-    }
-}
-declare const Types: {
-    CodeBlockTabs: {
-        convert(processor: Processor, nodes: Code[], withMdx?: boolean, withParent?: boolean): MdxJsxFlowElement;
-    };
-    Tabs: {
-        convert(processor: Processor, nodes: Code[], withMdx?: boolean, withParent?: boolean): MdxJsxFlowElement;
-    };
-};
-declare function remarkCodeTab(this: Processor, options?: RemarkCodeTabOptions): Transformer<Root, Root>;
-
-export { type RemarkHeadingOptions as R, type RemarkCodeTabOptions as a, remarkCodeTab as b, remarkHeading as r };