fumadocs-core 16.5.2 → 16.5.3

package/dist/mdx-plugins/codeblock-utils.d.ts

@@ -1,5 +1,5 @@
 import { BlockContent, Text } from "mdast";
-import { MdxJsxAttribute, MdxJsxFlowElement } from "mdast-util-mdx-jsx";
+import { MdxJsxAttribute, MdxJsxFlowElement } from "mdast-util-mdx";
 
 //#region src/mdx-plugins/codeblock-utils.d.ts
 interface CodeBlockTabsOptions {

package/dist/mdx-plugins/index.d.ts

@@ -3,7 +3,7 @@ import { r as transformerIcon, t as CodeBlockIcon } from "../transformer-icon-D7
 import { transformerTab } from "./rehype-code.core.js";
 import { RehypeCodeOptions, rehypeCode, rehypeCodeDefaultOptions } from "./rehype-code.js";
 import { RemarkImageOptions, remarkImage } from "./remark-image.js";
-import { StructureOptions, StructuredData, remarkStructure, remarkStructureDefaultOptions, structure } from "./remark-structure.js";
+import { StructureOptions, StructuredData, defaultStringify, remarkStructure, remarkStructureDefaultOptions, structure } from "./remark-structure.js";
 import { RemarkHeadingOptions, remarkHeading } from "./remark-heading.js";
 import { RemarkAdmonitionOptions, remarkAdmonition } from "./remark-admonition.js";
 import { RemarkDirectiveAdmonitionOptions, remarkDirectiveAdmonition } from "./remark-directive-admonition.js";
@@ -15,4 +15,4 @@ import { CodeBlockAttributes, CodeBlockTabsOptions, generateCodeBlockTabs, parse
 import { RemarkMdxFilesOptions, remarkMdxFiles } from "./remark-mdx-files.js";
 import { RemarkMdxMermaidOptions, remarkMdxMermaid } from "./remark-mdx-mermaid.js";
 import { FeedbackBlockProps, RemarkFeedbackBlockOptions, remarkFeedbackBlock } from "./remark-feedback-block.js";
-export { CodeBlockAttributes, CodeBlockIcon, CodeBlockTabsOptions, FeedbackBlockProps, RehypeCodeOptions, RehypeTocOptions, RemarkAdmonitionOptions, RemarkCodeTabOptions, RemarkDirectiveAdmonitionOptions, RemarkFeedbackBlockOptions, RemarkGfmOptions, RemarkHeadingOptions, RemarkImageOptions, type RemarkMdxFilesOptions, RemarkMdxMermaidOptions, RemarkNpmOptions, RemarkStepsOptions, StructureOptions, StructuredData, generateCodeBlockTabs, parseCodeBlockAttributes, rehypeCode, rehypeCodeDefaultOptions, rehypeToc, remarkAdmonition, remarkCodeTab, remarkDirectiveAdmonition, remarkFeedbackBlock, remarkGfm, remarkHeading, remarkImage, remarkMdxFiles, remarkMdxMermaid, remarkNpm, remarkSteps, remarkStructure, remarkStructureDefaultOptions, structure, transformerIcon, transformerTab };
+export { CodeBlockAttributes, CodeBlockIcon, CodeBlockTabsOptions, FeedbackBlockProps, RehypeCodeOptions, RehypeTocOptions, RemarkAdmonitionOptions, RemarkCodeTabOptions, RemarkDirectiveAdmonitionOptions, RemarkFeedbackBlockOptions, RemarkGfmOptions, RemarkHeadingOptions, RemarkImageOptions, type RemarkMdxFilesOptions, RemarkMdxMermaidOptions, RemarkNpmOptions, RemarkStepsOptions, StructureOptions, StructuredData, defaultStringify, generateCodeBlockTabs, parseCodeBlockAttributes, rehypeCode, rehypeCodeDefaultOptions, rehypeToc, remarkAdmonition, remarkCodeTab, remarkDirectiveAdmonition, remarkFeedbackBlock, remarkGfm, remarkHeading, remarkImage, remarkMdxFiles, remarkMdxMermaid, remarkNpm, remarkSteps, remarkStructure, remarkStructureDefaultOptions, structure, transformerIcon, transformerTab };

package/dist/mdx-plugins/index.js

@@ -6,7 +6,7 @@ import { t as transformerIcon } from "../transformer-icon-BYedaeE8.js";
 import { transformerTab } from "./rehype-code.core.js";
 import { rehypeCode, rehypeCodeDefaultOptions } from "./rehype-code.js";
 import { remarkImage } from "./remark-image.js";
-import { remarkStructure, remarkStructureDefaultOptions, structure } from "./remark-structure.js";
+import { defaultStringify, remarkStructure, remarkStructureDefaultOptions, structure } from "./remark-structure.js";
 import { remarkAdmonition } from "./remark-admonition.js";
 import { remarkDirectiveAdmonition } from "./remark-directive-admonition.js";
 import { rehypeToc } from "./rehype-toc.js";
@@ -17,4 +17,4 @@ import { remarkMdxFiles } from "./remark-mdx-files.js";
 import { remarkMdxMermaid } from "./remark-mdx-mermaid.js";
 import { remarkFeedbackBlock } from "./remark-feedback-block.js";
 
-export { generateCodeBlockTabs, parseCodeBlockAttributes, rehypeCode, rehypeCodeDefaultOptions, rehypeToc, remarkAdmonition, remarkCodeTab, remarkDirectiveAdmonition, remarkFeedbackBlock, remarkGfm, remarkHeading, remarkImage, remarkMdxFiles, remarkMdxMermaid, remarkNpm, remarkSteps, remarkStructure, remarkStructureDefaultOptions, structure, transformerIcon, transformerTab };
+export { defaultStringify, generateCodeBlockTabs, parseCodeBlockAttributes, rehypeCode, rehypeCodeDefaultOptions, rehypeToc, remarkAdmonition, remarkCodeTab, remarkDirectiveAdmonition, remarkFeedbackBlock, remarkGfm, remarkHeading, remarkImage, remarkMdxFiles, remarkMdxMermaid, remarkNpm, remarkSteps, remarkStructure, remarkStructureDefaultOptions, structure, transformerIcon, transformerTab };

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

@@ -1,6 +1,6 @@
 import { Processor, Transformer } from "unified";
 import { Code, Root } from "mdast";
-import { MdxJsxFlowElement } from "mdast-util-mdx-jsx";
+import { MdxJsxFlowElement } from "mdast-util-mdx";
 
 //#region src/mdx-plugins/remark-code-tab.d.ts
 type TabType = keyof typeof Types;

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

@@ -1,6 +1,6 @@
 import { Transformer } from "unified";
 import { Root } from "mdast";
-import { MdxJsxFlowElement } from "mdast-util-mdx-jsx";
+import { MdxJsxFlowElement } from "mdast-util-mdx";
 
 //#region src/mdx-plugins/remark-mdx-files.d.ts
 interface FileNode {

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

@@ -1,6 +1,7 @@
-import { PluggableList, Transformer } from "unified";
+import { Options } from "mdast-util-to-markdown";
+import { PluggableList, Processor, Transformer } from "unified";
 import { Nodes, Root } from "mdast";
-import { MdxJsxAttribute, MdxJsxExpressionAttribute, MdxJsxFlowElement } from "mdast-util-mdx-jsx";
+import { MdxJsxAttribute, MdxJsxExpressionAttribute, MdxJsxFlowElement, MdxJsxTextElement } from "mdast-util-mdx";
 
 //#region src/mdx-plugins/remark-structure.d.ts
 interface Heading$1 {
@@ -20,27 +21,33 @@ interface StructuredData {
 }
 interface StructureOptions {
   /**
-   * Types to be scanned as content.
+   * MDAST **block** types to be scanned as content.
+   *
+   * If a node's type is represented in this array, it will be stringified and its children will not be scanned separatedly.
    *
    * @defaultValue ['heading', 'paragraph', 'blockquote', 'tableCell', 'mdxJsxFlowElement']
    */
   types?: string[] | ((node: Nodes) => boolean);
   /**
-   * A list of indexable MDX attributes, either:
+   * stringify a given node & its children, you can use something like `mdast-util-to-markdown`.
+   */
+  stringify?: (this: Processor, node: Nodes) => string;
+  /**
+   * By default, it will not index MDX attributes. You can define a list of MDX attributes to index, either:
    *
    * - an array of attribute names.
    * - a function that determines if attribute should be indexed.
    */
-  allowedMdxAttributes?: string[] | ((node: MdxJsxFlowElement, attribute: MdxJsxAttribute | MdxJsxExpressionAttribute) => boolean);
+  allowedMdxAttributes?: string[] | ((node: MdxJsxFlowElement | MdxJsxTextElement, attribute: MdxJsxAttribute | MdxJsxExpressionAttribute) => boolean);
   /**
-   * export as `structuredData` or specified variable name.
+   * export as `structuredData` (if true) or specified variable name.
    */
   exportAs?: string | boolean;
 }
 declare module 'mdast' {
   interface Data {
     /**
-     * [Fumadocs] Get content of unserializable element, `remarkStructure` uses it to generate search index.
+     * [Fumadocs] Stringified form of node, `remarkStructure` uses it to generate search index.
      */
     _string?: string[];
   }
@@ -55,7 +62,7 @@ declare module 'vfile' {
 }
 declare const remarkStructureDefaultOptions: {
   types: string[];
-  allowedMdxAttributes: (node: MdxJsxFlowElement) => boolean;
+  allowedMdxAttributes(node: MdxJsxFlowElement | MdxJsxTextElement): boolean;
   exportAs: false;
 };
 /**
@@ -63,8 +70,9 @@ declare const remarkStructureDefaultOptions: {
  *
  * By default, the output is stored into VFile (`vfile.data.structuredData`), you can specify `exportAs` to export it.
  */
-declare function remarkStructure({
+declare function remarkStructure(this: Processor, {
   types,
+  stringify,
   allowedMdxAttributes,
   exportAs
 }?: StructureOptions): Transformer<Root, Root>;
@@ -72,5 +80,8 @@ declare function remarkStructure({
  * Extract data from markdown/mdx content
  */
 declare function structure(content: string, remarkPlugins?: PluggableList, options?: StructureOptions): StructuredData;
+declare function defaultStringify(config?: Options & {
+  filterMdxAttributes?: (node: MdxJsxFlowElement | MdxJsxTextElement, attribute: MdxJsxAttribute | MdxJsxExpressionAttribute) => boolean;
+}): (this: Processor, node: Nodes) => string;
 //#endregion
-export { StructureOptions, StructuredData, remarkStructure, remarkStructureDefaultOptions, structure };
+export { StructureOptions, StructuredData, defaultStringify, remarkStructure, remarkStructureDefaultOptions, structure };

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

@@ -1,8 +1,9 @@
 import { n as toMdxExport, t as flattenNode } from "../mdast-utils-gJMY143g.js";
+import { remarkHeading } from "./remark-heading.js";
 import { remark } from "remark";
 import remarkGfm from "remark-gfm";
-import Slugger from "github-slugger";
 import { visit } from "unist-util-visit";
+import { toMarkdown } from "mdast-util-to-markdown";
 
 //#region src/mdx-plugins/remark-structure.ts
 const remarkStructureDefaultOptions = {
@@ -13,9 +14,12 @@ const remarkStructureDefaultOptions = {
 		"tableCell",
 		"mdxJsxFlowElement"
 	],
-	allowedMdxAttributes: (node) => {
-		if (!node.name) return false;
-		return ["TypeTable", "Callout"].includes(node.name);
+	allowedMdxAttributes(node) {
+		switch (node.name) {
+			case "TypeTable":
+			case "Callout": return true;
+			default: return false;
+		}
 	},
 	exportAs: false
 };
@@ -24,8 +28,7 @@ const remarkStructureDefaultOptions = {
 *
 * By default, the output is stored into VFile (`vfile.data.structuredData`), you can specify `exportAs` to export it.
 */
-function remarkStructure({ types = remarkStructureDefaultOptions.types, allowedMdxAttributes = remarkStructureDefaultOptions.allowedMdxAttributes, exportAs = remarkStructureDefaultOptions.exportAs } = {}) {
-	const slugger = new Slugger();
+function remarkStructure({ types = remarkStructureDefaultOptions.types, stringify, allowedMdxAttributes = remarkStructureDefaultOptions.allowedMdxAttributes, exportAs = remarkStructureDefaultOptions.exportAs } = {}) {
 	if (Array.isArray(allowedMdxAttributes)) {
 		const arr = allowedMdxAttributes;
 		allowedMdxAttributes = (_node, attribute) => attribute.type === "mdxJsxAttribute" && arr.includes(attribute.name);
@@ -34,8 +37,8 @@ function remarkStructure({ types = remarkStructureDefaultOptions.types, allowedM
 		const arr = types;
 		types = (node) => arr.includes(node.type);
 	}
+	stringify ??= defaultStringify({ filterMdxAttributes: allowedMdxAttributes });
 	return (tree, file) => {
-		slugger.reset();
 		const data = {
 			contents: [],
 			headings: []
@@ -53,12 +56,14 @@ function remarkStructure({ types = remarkStructureDefaultOptions.types, allowedM
 			if (element.type === "heading") {
 				element.data ||= {};
 				element.data.hProperties ||= {};
-				const properties = element.data.hProperties;
-				const content = flattenNode(element).trim();
-				const id = properties.id ?? slugger.slug(content);
+				const id = element.data.hProperties.id;
+				if (typeof id !== "string") {
+					console.warn("[remark-structure] hProperties.id is missing in heading node, it is required to generate heading data. You can add remark-heading prior to remark-structure to generate heading IDs.");
+					return "skip";
+				}
 				data.headings.push({
 					id,
-					content
+					content: flattenNode(element).trim()
 				});
 				lastHeading = id;
 				return "skip";
@@ -70,21 +75,8 @@ function remarkStructure({ types = remarkStructureDefaultOptions.types, allowedM
 				});
 				return "skip";
 			}
-			if (element.type === "mdxJsxFlowElement" && element.name) {
-				data.contents.push(...element.attributes.flatMap((attribute) => {
-					const value = typeof attribute.value === "string" ? attribute.value : attribute.value?.value;
-					if (!value || value.length === 0) return [];
-					if (allowedMdxAttributes && !allowedMdxAttributes(element, attribute)) return [];
-					return {
-						heading: lastHeading,
-						content: attribute.type === "mdxJsxAttribute" ? `${attribute.name}: ${value}` : value
-					};
-				}));
-				return;
-			}
-			const content = flattenNode(element).trim();
-			if (content.length === 0) return;
-			data.contents.push({
+			const content = stringify.call(this, element).trim();
+			if (content.length > 0) data.contents.push({
 				heading: lastHeading,
 				content
 			});
@@ -98,8 +90,47 @@ function remarkStructure({ types = remarkStructureDefaultOptions.types, allowedM
 * Extract data from markdown/mdx content
 */
 function structure(content, remarkPlugins = [], options = {}) {
-	return remark().use(remarkGfm).use(remarkPlugins).use(remarkStructure, options).processSync(content).data.structuredData;
+	return remark().use(remarkGfm).use(remarkPlugins).use(remarkHeading).use(remarkStructure, options).processSync(content).data.structuredData;
+}
+function defaultStringify(config = {}) {
+	const { filterMdxAttributes } = config;
+	function modHandler(handler) {
+		return function(node, ...rest) {
+			if (node.data?._string) return node.data._string.join("\n");
+			switch (node.type) {
+				case "mdxJsxFlowElement":
+				case "mdxJsxTextElement": if (filterMdxAttributes) {
+					const temp = node.attributes;
+					node.attributes = node.attributes.filter((attr) => filterMdxAttributes(node, attr));
+					const s = handler(node, ...rest);
+					node.attributes = temp;
+					return s;
+				}
+				default: return handler(node, ...rest);
+			}
+		};
+	}
+	const handlers = {
+		...config.handlers,
+		_custom(node, _, state, info) {
+			const handlers = state.handlers;
+			for (const k in handlers) handlers[k] = modHandler(handlers[k]);
+			return state.handle(node.root, void 0, state, info);
+		}
+	};
+	return function(root) {
+		const defaultExtensions = this.data("toMarkdownExtensions") ?? [];
+		return toMarkdown({
+			type: "_custom",
+			root
+		}, {
+			...this.data("settings"),
+			...config,
+			extensions: config.extensions ? [...defaultExtensions, ...config.extensions] : defaultExtensions,
+			handlers
+		});
+	};
 }
 
 //#endregion
-export { remarkStructure, remarkStructureDefaultOptions, structure };
+export { defaultStringify, remarkStructure, remarkStructureDefaultOptions, structure };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-core",
-  "version": "16.5.2",
+  "version": "16.5.3",
   "description": "The React.js library for building a documentation website",
   "keywords": [
     "Docs",
@@ -125,6 +125,8 @@
     "hast-util-to-estree": "^3.1.3",
     "hast-util-to-jsx-runtime": "^2.3.6",
     "image-size": "^2.0.2",
+    "mdast-util-mdx": "^3.0.0",
+    "mdast-util-to-markdown": "^2.1.2",
     "negotiator": "^1.0.0",
     "npm-to-yarn": "^3.0.1",
     "path-to-regexp": "^8.3.0",
@@ -153,8 +155,6 @@
     "@types/react-dom": "^19.2.3",
     "algoliasearch": "5.48.0",
     "lucide-react": "^0.563.0",
-    "mdast-util-mdx-jsx": "^3.2.0",
-    "mdast-util-mdxjs-esm": "^2.0.1",
     "next": "16.1.6",
     "react-router": "^7.13.0",
     "remark-directive": "^4.0.0",
@@ -179,7 +179,6 @@
     "@types/react": "*",
     "algoliasearch": "5.x.x",
     "lucide-react": "*",
-    "mdast-util-mdx-jsx": "*",
     "next": "16.x.x",
     "react": "^19.2.0",
     "react-dom": "^19.2.0",
@@ -188,9 +187,6 @@
     "zod": "4.x.x"
   },
   "peerDependenciesMeta": {
-    "mdast-util-mdx-jsx": {
-      "optional": true
-    },
     "@mdx-js/mdx": {
       "optional": true
     },