fumadocs-core 15.2.6 → 15.2.8

package/dist/{chunk-IYQ35KI2.js → chunk-Y2774T3B.js}

@@ -33,7 +33,7 @@ function remarkHeading({
           lastNode.value = lastNode.value.slice(0, match.index);
         }
       }
-      let flattened;
+      let flattened = null;
       if (!id) {
         flattened ??= flattenNode(heading);
         id = defaultSlug ? defaultSlug(root, heading, flattened) : slugger.slug(flattened);

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

@@ -4,8 +4,9 @@ import { RehypeShikiOptions } from '@shikijs/rehype';
 import { Processor, Transformer } from 'unified';
 import { ShikiTransformer } from 'shiki';
 import { Root as Root$1 } from 'mdast';
-export { a as StructureOptions, S as StructuredData, r as remarkStructure, s as structure } from '../remark-structure-1kvQbrfH.js';
+export { a as StructureOptions, S as StructuredData, r as remarkStructure, s as structure } from '../remark-structure-FIjTA11P.js';
 export { R as RemarkHeadingOptions, r as remarkHeading } from '../remark-heading-BPCoYwjn.js';
+import 'mdast-util-mdx-jsx';
 
 interface CodeBlockIcon {
     viewBox: string;
@@ -113,4 +114,23 @@ declare function rehypeToc(this: Processor, { exportToc }?: RehypeTocOptions): T
 
 declare function remarkCodeTab(): Transformer<Root$1, Root$1>;
 
-export { type CodeBlockIcon, type RehypeCodeOptions, type RehypeTocOptions, type RemarkAdmonitionOptions, type RemarkImageOptions, rehypeCode, rehypeCodeDefaultOptions, rehypeToc, remarkAdmonition, remarkCodeTab, remarkImage, transformerIcon, transformerTab };
+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$1, Root$1>;
+
+export { type CodeBlockIcon, type RehypeCodeOptions, type RehypeTocOptions, type RemarkAdmonitionOptions, type RemarkImageOptions, type RemarkStepsOptions, rehypeCode, rehypeCodeDefaultOptions, rehypeToc, remarkAdmonition, remarkCodeTab, remarkImage, remarkSteps, transformerIcon, transformerTab };

package/dist/mdx-plugins/index.js

@@ -1,7 +1,7 @@
 import {
   flattenNode,
   remarkHeading
-} from "../chunk-IYQ35KI2.js";
+} from "../chunk-Y2774T3B.js";
 import {
   joinPath,
   slash
@@ -185,10 +185,6 @@ var metaValues = [
   {
     name: "tab",
     regex: /tab="(?<value>[^"]+)"/
-  },
-  {
-    name: "tab",
-    regex: /tab/
   }
 ];
 var rehypeCodeDefaultOptions = {
@@ -281,7 +277,7 @@ function transformerTab() {
             data: {
               _codeblock: true
             },
-            attributes: value !== "" ? [{ type: "mdxJsxAttribute", name: "value", value }] : [],
+            attributes: [{ type: "mdxJsxAttribute", name: "value", value }],
             children: root.children
           }
         ]
@@ -447,8 +443,23 @@ import remarkGfm from "remark-gfm";
 import { visit as visit2 } from "unist-util-visit";
 var slugger = new Slugger();
 function remarkStructure({
-  types = ["paragraph", "blockquote", "heading", "tableCell"]
+  types = [
+    "heading",
+    "paragraph",
+    "blockquote",
+    "tableCell",
+    "mdxJsxFlowElement"
+  ],
+  allowedMdxAttributes = () => true
 } = {}) {
+  if (Array.isArray(allowedMdxAttributes)) {
+    const arr = allowedMdxAttributes;
+    allowedMdxAttributes = (_node, attribute) => attribute.type === "mdxJsxAttribute" && arr.includes(attribute.name);
+  }
+  if (Array.isArray(types)) {
+    const arr = types;
+    types = (node) => arr.includes(node.type);
+  }
   return (node, file) => {
     slugger.reset();
     const data = { contents: [], headings: [] };
@@ -462,24 +473,25 @@ function remarkStructure({
     }
     visit2(node, (element) => {
       if (element.type === "root") return;
+      if (!types(element)) return;
       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 content2 = flattenNode(element).trim();
+        const id = properties.id ?? slugger.slug(content2);
         data.headings.push({
           id,
-          content
+          content: content2
         });
         lastHeading = id;
         return "skip";
       }
       if (element.data?._string) {
-        for (const content of element.data._string) {
+        for (const content2 of element.data._string) {
           data.contents.push({
             heading: lastHeading,
-            content
+            content: content2
           });
         }
         return "skip";
@@ -493,6 +505,8 @@ function remarkStructure({
           ...element.attributes.flatMap((attribute) => {
             const valueStr = typeof attribute.value === "string" ? attribute.value : attribute.value?.value;
             if (!valueStr) return [];
+            if (allowedMdxAttributes && !allowedMdxAttributes(element, attribute))
+              return [];
             return {
               heading: lastHeading,
               content: attribute.type === "mdxJsxAttribute" ? `${attribute.name}: ${valueStr}` : valueStr
@@ -501,15 +515,13 @@ function remarkStructure({
         );
         return;
       }
-      if (types.includes(element.type)) {
-        const content = flattenNode(element).trim();
-        if (content.length === 0) return;
-        data.contents.push({
-          heading: lastHeading,
-          content
-        });
-        return "skip";
-      }
+      const content = flattenNode(element).trim();
+      if (content.length === 0) return;
+      data.contents.push({
+        heading: lastHeading,
+        content
+      });
+      return "skip";
     });
     file.data.structuredData = data;
   };
@@ -787,32 +799,123 @@ function toTab(nodes) {
 function remarkCodeTab() {
   return (tree) => {
     visit5(tree, (node) => {
+      if (!("children" in node)) return;
       if (node.type === "mdxJsxFlowElement" && node.name === "Tabs") return;
-      if ("children" in node) {
-        let start = -1;
-        let i = 0;
-        while (i < node.children.length) {
-          const child = node.children[i];
-          const isSwitcher = child.type === "code" && child.meta && child.meta.match(TabRegex);
-          if (isSwitcher && start === -1) {
-            start = i;
-          }
-          const isLast = i === node.children.length - 1;
-          if (start !== -1 && (isLast || !isSwitcher)) {
-            const end = isSwitcher ? i + 1 : i;
-            const targets = node.children.slice(start, end);
-            node.children.splice(
-              start,
-              end - start,
-              toTab(targets)
-            );
-            if (isLast) break;
-            i = start;
-            start = -1;
-          }
-          i++;
+      let start = -1;
+      let i = 0;
+      while (i < node.children.length) {
+        const child = node.children[i];
+        const isSwitcher = child.type === "code" && child.meta && child.meta.match(TabRegex);
+        if (isSwitcher && start === -1) {
+          start = i;
+        }
+        const isLast = i === node.children.length - 1;
+        if (start !== -1 && (isLast || !isSwitcher)) {
+          const end = isSwitcher ? i + 1 : i;
+          const targets = node.children.slice(start, end);
+          node.children.splice(
+            start,
+            end - start,
+            toTab(targets)
+          );
+          if (isLast) break;
+          i = start;
+          start = -1;
+        }
+        i++;
+      }
+    });
+  };
+}
+
+// src/mdx-plugins/remark-steps.ts
+import { visit as visit6 } from "unist-util-visit";
+var StepRegex = /^(\d+)\.\s(.+)$/;
+function remarkSteps({
+  steps = "fd-steps",
+  step = "fd-step"
+} = {}) {
+  function convertToSteps(nodes) {
+    const depth = nodes[0].depth;
+    const children = [];
+    for (const node of nodes) {
+      if (node.type === "heading" && node.depth === depth) {
+        children.push({
+          type: "mdxJsxFlowElement",
+          name: "div",
+          attributes: [
+            {
+              type: "mdxJsxAttribute",
+              name: "className",
+              value: step
+            }
+          ],
+          children: [node]
+        });
+      } else {
+        children[children.length - 1].children.push(node);
+      }
+    }
+    return {
+      type: "mdxJsxFlowElement",
+      name: "div",
+      attributes: [
+        {
+          type: "mdxJsxAttribute",
+          name: "className",
+          value: steps
+        }
+      ],
+      data: {
+        _fd_step: true
+      },
+      children
+    };
+  }
+  return (tree) => {
+    visit6(tree, (parent) => {
+      if (!("children" in parent) || parent.type === "heading") return;
+      if (parent.data && "_fd_step" in parent.data) return "skip";
+      let startIdx = -1;
+      let lastNumber = 0;
+      let i = 0;
+      const onEnd = () => {
+        if (startIdx === -1) return;
+        const item = {};
+        const nodes = parent.children.splice(
+          startIdx,
+          i - startIdx,
+          item
+        );
+        Object.assign(item, convertToSteps(nodes));
+        i = startIdx + 1;
+        startIdx = -1;
+      };
+      for (; i < parent.children.length; i++) {
+        const node = parent.children[i];
+        if (node.type !== "heading") continue;
+        if (startIdx !== -1) {
+          const startDepth = parent.children[startIdx].depth;
+          if (node.depth > startDepth) continue;
+          else if (node.depth < startDepth) onEnd();
+        }
+        const head = node.children.filter((c) => c.type === "text").at(0);
+        if (!head) {
+          onEnd();
+          continue;
+        }
+        const match = StepRegex.exec(head.value);
+        if (!match) {
+          onEnd();
+          continue;
         }
+        const num = Number(match[1]);
+        head.value = match[2];
+        if (startIdx !== -1 && num !== lastNumber + 1) onEnd();
+        if (startIdx === -1) startIdx = i;
+        lastNumber = num;
       }
+      onEnd();
     });
   };
 }
@@ -825,6 +928,7 @@ export {
   default2 as remarkGfm,
   remarkHeading,
   remarkImage,
+  remarkSteps,
   remarkStructure,
   structure,
   transformerIcon,

package/dist/{remark-structure-1kvQbrfH.d.ts → remark-structure-FIjTA11P.d.ts}

@@ -1,5 +1,6 @@
-import { Root } from 'mdast';
+import { Nodes, Root } from 'mdast';
 import { Transformer, PluggableList } from 'unified';
+import { MdxJsxAttribute, MdxJsxExpressionAttribute } from 'mdast-util-mdx-jsx';
 
 interface Heading {
     id: string;
@@ -20,9 +21,10 @@ interface StructureOptions {
     /**
      * Types to be scanned as content.
      *
-     * @defaultValue ['paragraph', 'blockquote', 'tableCell']
+     * @defaultValue ['heading', 'paragraph', 'blockquote', 'tableCell', 'mdxJsxFlowElement']
      */
-    types?: string[];
+    types?: string[] | ((node: Nodes) => boolean);
+    allowedMdxAttributes?: string[] | ((node: Nodes, attribute: MdxJsxAttribute | MdxJsxExpressionAttribute) => boolean);
 }
 declare module 'mdast' {
     interface Data {
@@ -37,7 +39,7 @@ declare module 'mdast' {
 /**
  * Attach structured data to VFile, you can access via `vfile.data.structuredData`.
  */
-declare function remarkStructure({ types, }?: StructureOptions): Transformer<Root, Root>;
+declare function remarkStructure({ types, allowedMdxAttributes, }?: StructureOptions): Transformer<Root, Root>;
 /**
  * Extract data from markdown/mdx content
  */

package/dist/search/algolia.d.ts

@@ -1,7 +1,8 @@
 import { SearchClient, SearchIndex } from 'algoliasearch';
-import { S as StructuredData } from '../remark-structure-1kvQbrfH.js';
+import { S as StructuredData } from '../remark-structure-FIjTA11P.js';
 import 'mdast';
 import 'unified';
+import 'mdast-util-mdx-jsx';
 
 interface DocumentRecord {
     /**

package/dist/search/client.d.ts

@@ -2,10 +2,11 @@ import { S as SortedResult } from '../types-Ch8gnVgO.js';
 import { AnyOrama } from '@orama/orama';
 import { SearchOptions } from '@algolia/client-search';
 import { SearchIndex } from 'algoliasearch/lite';
-import '../remark-structure-1kvQbrfH.js';
+import '../remark-structure-FIjTA11P.js';
 import { OramaClient, ClientSearchParams } from '@oramacloud/client';
 import 'mdast';
 import 'unified';
+import 'mdast-util-mdx-jsx';
 
 interface FetchOptions {
     /**

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

@@ -1,8 +1,9 @@
 import { CloudManager } from '@oramacloud/client';
-import { S as StructuredData } from '../remark-structure-1kvQbrfH.js';
+import { S as StructuredData } from '../remark-structure-FIjTA11P.js';
 import '../remark-heading-BPCoYwjn.js';
 import 'mdast';
 import 'unified';
+import 'mdast-util-mdx-jsx';
 
 interface SyncOptions {
     /**

package/dist/search/server.d.ts

@@ -1,10 +1,11 @@
 import { TypedDocument, Orama, Language, RawData, create, SearchParams } from '@orama/orama';
-import { S as StructuredData } from '../remark-structure-1kvQbrfH.js';
+import { S as StructuredData } from '../remark-structure-FIjTA11P.js';
 import { S as SortedResult } from '../types-Ch8gnVgO.js';
 import { I as I18nConfig } from '../config-inq6kP6y.js';
 import { LoaderOutput, LoaderConfig, InferPageType } from '../source/index.js';
 import 'mdast';
 import 'unified';
+import 'mdast-util-mdx-jsx';
 import 'react';
 import '../page-tree-BG3wP0gU.js';
 

package/dist/server/index.js

@@ -1,6 +1,6 @@
 import {
   remarkHeading
-} from "../chunk-IYQ35KI2.js";
+} from "../chunk-Y2774T3B.js";
 import "../chunk-MLKGABMK.js";
 
 // src/server/get-toc.ts

package/dist/source/index.js

@@ -151,7 +151,7 @@ function build(ctx) {
   const root = ctx.storage.root();
   const folder = buildFolderNode(root, true, ctx);
   return {
-    $id: "root",
+    $id: ctx.locale ? ctx.locale : "root",
     name: folder.name,
     children: folder.children
   };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-core",
-  "version": "15.2.6",
+  "version": "15.2.8",
   "description": "The library for building a documentation website in Next.js",
   "keywords": [
     "NextJs",
@@ -78,9 +78,9 @@
   ],
   "dependencies": {
     "@formatjs/intl-localematcher": "^0.6.1",
-    "@orama/orama": "^3.1.4",
-    "@shikijs/rehype": "^3.2.1",
-    "@shikijs/transformers": "^3.2.1",
+    "@orama/orama": "^3.1.6",
+    "@shikijs/rehype": "^3.2.2",
+    "@shikijs/transformers": "^3.2.2",
     "github-slugger": "^2.0.0",
     "hast-util-to-estree": "^3.1.3",
     "hast-util-to-jsx-runtime": "^2.3.6",
@@ -90,26 +90,26 @@
     "remark": "^15.0.0",
     "remark-gfm": "^4.0.1",
     "scroll-into-view-if-needed": "^3.1.0",
-    "shiki": "^3.2.1",
+    "shiki": "^3.2.2",
     "unist-util-visit": "^5.0.0"
   },
   "devDependencies": {
     "@algolia/client-search": "4.24.0",
     "@mdx-js/mdx": "^3.1.0",
     "@oramacloud/client": "^2.1.4",
-    "@tanstack/react-router": "^1.115.2",
+    "@tanstack/react-router": "^1.116.0",
     "@types/estree-jsx": "^1.0.5",
     "@types/hast": "^3.0.4",
     "@types/mdast": "^4.0.3",
     "@types/negotiator": "^0.6.3",
-    "@types/node": "22.14.0",
-    "@types/react": "^19.1.0",
-    "@types/react-dom": "^19.1.1",
+    "@types/node": "22.14.1",
+    "@types/react": "^19.1.2",
+    "@types/react-dom": "^19.1.2",
     "algoliasearch": "4.24.0",
     "mdast-util-mdx-jsx": "^3.2.0",
     "mdast-util-mdxjs-esm": "^2.0.1",
-    "next": "^15.2.4",
-    "react-router": "^7.5.0",
+    "next": "^15.3.1",
+    "react-router": "^7.5.1",
     "remark-mdx": "^3.1.0",
     "remark-rehype": "^11.1.2",
     "typescript": "^5.8.3",