fumadocs-core 11.3.2 → 12.0.0

package/dist/breadcrumb.d.ts

@@ -1,4 +1,4 @@
-import { R as Root } from './page-tree-_omg_2NB.js';
+import { R as Root } from './page-tree-_z0bnHIU.js';
 import 'react';
 
 interface BreadcrumbItem {

package/dist/{chunk-EWRPHFJQ.js → chunk-QRNTLL6S.js}

@@ -1,6 +1,16 @@
 // src/mdx-plugins/remark-heading.ts
 import Slugger from "github-slugger";
 import { visit } from "unist-util-visit";
+
+// src/mdx-plugins/remark-utils.ts
+function flattenNode(node) {
+  if ("children" in node)
+    return node.children.map((child) => flattenNode(child)).join("");
+  if ("value" in node) return node.value;
+  return "";
+}
+
+// src/mdx-plugins/remark-heading.ts
 var slugger = new Slugger();
 var regex = new RegExp("\\s*\\[#(?<slug>[^]+?)]\\s*$");
 function remarkHeading({
@@ -12,24 +22,24 @@ function remarkHeading({
     slugger.reset();
     visit(root, "heading", (heading) => {
       var _a;
-      const node = heading.children.at(-1);
-      if (!node || node.type !== "text") return;
       heading.data || (heading.data = {});
       (_a = heading.data).hProperties || (_a.hProperties = {});
-      let id = heading.data.hProperties.id;
-      if (!id && customId) {
-        const match = regex.exec(node.value);
+      const lastNode = heading.children.at(-1);
+      if (!heading.data.hProperties.id && (lastNode == null ? void 0 : lastNode.type) === "text" && customId) {
+        const match = regex.exec(lastNode.value);
         if (match == null ? void 0 : match[1]) {
-          id = match[1];
-          node.value = node.value.slice(0, match.index);
+          heading.data.hProperties.id = match[1];
+          lastNode.value = lastNode.value.slice(0, match.index);
         }
       }
+      const value = flattenNode(heading);
+      let id = heading.data.hProperties.id;
       if (!id) {
-        id = defaultSlug ? defaultSlug(root, heading, node.value) : slugger.slug(node.value);
+        id = defaultSlug ? defaultSlug(root, heading, value) : slugger.slug(value);
       }
       heading.data.hProperties.id = id;
       toc.push({
-        title: node.value,
+        title: value,
         url: `#${id}`,
         depth: heading.depth
       });
@@ -40,5 +50,6 @@ function remarkHeading({
 }
 
 export {
+  flattenNode,
   remarkHeading
 };

package/dist/mdx-plugins/index.js

@@ -1,6 +1,7 @@
 import {
+  flattenNode,
   remarkHeading
-} from "../chunk-EWRPHFJQ.js";
+} from "../chunk-QRNTLL6S.js";
 import {
   slash
 } from "../chunk-UWEEHUJV.js";
@@ -163,7 +164,7 @@ function transformerIcon(options = {}) {
       const lang = this.options.lang;
       if (!lang) return;
       const pre = root.children[0];
-      if (pre.type !== "element") return;
+      if (pre.type !== "element" || pre.tagName !== "pre") return;
       const iconName = lang in shortcuts ? shortcuts[lang] : lang;
       const icon = iconName in icons ? icons[iconName] : icons.default;
       const tree = toEstree(pre, {
@@ -460,16 +461,6 @@ import { remark } from "remark";
 import remarkGfm from "remark-gfm";
 import remarkMdx from "remark-mdx";
 import { visit as visit3 } from "unist-util-visit";
-
-// src/mdx-plugins/remark-utils.ts
-function flattenNode(node) {
-  if ("children" in node)
-    return node.children.map((child) => flattenNode(child)).join("");
-  if ("value" in node) return node.value;
-  return "";
-}
-
-// src/mdx-plugins/remark-structure.ts
 var slugger = new Slugger();
 function remarkStructure({
   types = ["paragraph", "blockquote", "heading"]

package/dist/{page-tree-_omg_2NB.d.ts → page-tree-_z0bnHIU.d.ts}

@@ -17,6 +17,10 @@ interface Separator {
     name: string;
 }
 interface Folder {
+    /**
+     * Optional id to be attached to folders
+     */
+    id?: string;
     type: 'folder';
     name: string;
     root?: boolean;
@@ -35,4 +39,4 @@ declare namespace pageTree {
   export type { pageTree_Folder as Folder, pageTree_Item as Item, pageTree_Node as Node, pageTree_Root as Root, pageTree_Separator as Separator };
 }
 
-export { type Item as I, type Node as N, type Root as R, pageTree as p };
+export { type Folder as F, type Item as I, type Node as N, type Root as R, type Separator as S, pageTree as p };

package/dist/server/index.d.ts

@@ -1,6 +1,6 @@
 export { a as TOCItemType, T as TableOfContents, g as getTableOfContents } from '../get-toc-B-AMfFKT.js';
-import { N as Node, I as Item, R as Root } from '../page-tree-_omg_2NB.js';
-export { p as PageTree } from '../page-tree-_omg_2NB.js';
+import { N as Node, I as Item, R as Root } from '../page-tree-_z0bnHIU.js';
+export { p as PageTree } from '../page-tree-_z0bnHIU.js';
 import 'react';
 
 /**

package/dist/server/index.js

@@ -1,6 +1,6 @@
 import {
   remarkHeading
-} from "../chunk-EWRPHFJQ.js";
+} from "../chunk-QRNTLL6S.js";
 import {
   __async
 } from "../chunk-UWTMEZUM.js";

package/dist/sidebar.d.ts

@@ -12,15 +12,11 @@ type AsProps<T extends ElementType> = Omit<ComponentPropsWithoutRef<T>, 'as'> &
 type SidebarTriggerProps<T extends ElementType> = AsProps<T>;
 declare function SidebarTrigger<T extends ElementType = 'button'>({ as, ...props }: SidebarTriggerProps<T>): ReactElement;
 type SidebarContentProps<T extends ElementType> = AsProps<T> & {
-    /**
-     * @deprecated Use `blockScrollingWidth` instead
-     */
-    minWidth?: number;
     /**
      * Disable scroll blocking when the viewport width is larger than a certain number (in pixels)
      */
     blockScrollingWidth?: number;
 };
-declare function SidebarList<T extends ElementType = 'aside'>({ as, minWidth, blockScrollingWidth, ...props }: SidebarContentProps<T>): ReactElement;
+declare function SidebarList<T extends ElementType = 'aside'>({ as, blockScrollingWidth, ...props }: SidebarContentProps<T>): ReactElement;
 
 export { type SidebarContentProps, SidebarList, SidebarProvider, type SidebarProviderProps, SidebarTrigger, type SidebarTriggerProps };

package/dist/sidebar.js

@@ -5,7 +5,6 @@ import {
 } from "./chunk-UWTMEZUM.js";
 
 // src/sidebar.tsx
-import { usePathname } from "next/navigation";
 import {
   useCallback,
   createContext,
@@ -28,10 +27,6 @@ function SidebarProvider(props) {
     (_a = props.open) != null ? _a : openInner,
     (_b = props.onOpenChange) != null ? _b : setOpenInner
   ];
-  const pathname = usePathname();
-  useEffect(() => {
-    setOpen(false);
-  }, [pathname, setOpen]);
   return /* @__PURE__ */ jsx(SidebarContext.Provider, { value: [open, setOpen], children: props.children });
 }
 function SidebarTrigger(_a) {
@@ -56,11 +51,9 @@ function SidebarTrigger(_a) {
 function SidebarList(_a) {
   var _b = _a, {
     as,
-    minWidth,
-    blockScrollingWidth = minWidth
+    blockScrollingWidth
   } = _b, props = __objRest(_b, [
     "as",
-    "minWidth",
     "blockScrollingWidth"
   ]);
   const [open] = useSidebarContext();

package/dist/source/index.d.ts

@@ -1,5 +1,5 @@
 import { ReactElement } from 'react';
-import { R as Root } from '../page-tree-_omg_2NB.js';
+import { R as Root, I as Item, F as Folder$1, S as Separator } from '../page-tree-_z0bnHIU.js';
 
 interface FileInfo {
     locale?: string;
@@ -97,11 +97,15 @@ interface LoaderOptions {
      */
     baseUrl?: string;
     languages?: string[];
-    icon?: NonNullable<CreatePageTreeBuilderOptions['resolveIcon']>;
+    icon?: NonNullable<BuildPageTreeOptions['resolveIcon']>;
     slugs?: LoadOptions['getSlugs'];
     url?: UrlFn;
     source: Source<any>;
     transformers?: Transformer[];
+    /**
+     * Additional options for page tree builder
+     */
+    pageTree?: Partial<Omit<BuildPageTreeOptions, 'storage' | 'getUrl'>>;
 }
 interface Source<Config extends SourceConfig> {
     /**
@@ -177,21 +181,30 @@ interface FileData {
     };
 }
 
-interface BuildPageTreeOptionsWithI18n {
-    languages: string[];
-}
-interface PageTreeBuilder {
-    build: () => Root;
+interface BuildPageTreeOptions {
     /**
-     * Build page tree and fallback to the default language if the localized page doesn't exist
+     * Attach the `folder.id` property
+     *
+     * @defaultValue false
      */
-    buildI18n: (options?: Partial<BuildPageTreeOptionsWithI18n>) => Record<string, Root>;
-}
-interface CreatePageTreeBuilderOptions {
+    attachFolderIds?: boolean;
+    attachFile?: (node: Item, file?: File) => Item;
+    attachFolder?: (node: Folder$1, folder: Folder, meta?: File) => Folder$1;
+    attachSeparator?: (node: Separator) => Separator;
     storage: Storage;
     getUrl: UrlFn;
     resolveIcon?: (icon: string | undefined) => ReactElement | undefined;
 }
-declare function createPageTreeBuilder(options: CreatePageTreeBuilderOptions): PageTreeBuilder;
+interface BuildPageTreeOptionsWithI18n extends BuildPageTreeOptions {
+    languages?: string[];
+}
+interface PageTreeBuilder {
+    build: (options: BuildPageTreeOptions) => Root;
+    /**
+     * Build page tree and fallback to the default language if the localized page doesn't exist
+     */
+    buildI18n: (options: BuildPageTreeOptionsWithI18n) => Record<string, Root>;
+}
+declare function createPageTreeBuilder(): PageTreeBuilder;
 
-export { type BuildPageTreeOptionsWithI18n, type CreatePageTreeBuilderOptions, type FileData, type FileInfo, fileSystem as FileSystem, type InferMetaType, type InferPageType, type LanguageEntry, type LoadOptions, type LoaderConfig, type LoaderOptions, type LoaderOutput, type Meta, type MetaData, type Page, type PageData, type PageTreeBuilder, type Source, type SourceConfig, type Transformer, type UrlFn, type VirtualFile, createGetUrl, createPageTreeBuilder, getSlugs, loader, parseFilePath, parseFolderPath };
+export { type BuildPageTreeOptions, type BuildPageTreeOptionsWithI18n, type FileData, type FileInfo, fileSystem as FileSystem, type InferMetaType, type InferPageType, type LanguageEntry, type LoadOptions, type LoaderConfig, type LoaderOptions, type LoaderOutput, type Meta, type MetaData, type Page, type PageData, type PageTreeBuilder, type Source, type SourceConfig, type Transformer, type UrlFn, type VirtualFile, createGetUrl, createPageTreeBuilder, getSlugs, loader, parseFilePath, parseFolderPath };

package/dist/source/index.js

@@ -3,7 +3,7 @@ import {
 } from "../chunk-UWEEHUJV.js";
 import {
   __export,
-  __spreadProps,
+  __objRest,
   __spreadValues
 } from "../chunk-UWTMEZUM.js";
 
@@ -85,36 +85,34 @@ function buildAll(nodes, ctx, skipIndex) {
   return output;
 }
 function resolveFolderItem(folder, item, ctx, addedNodePaths) {
-  var _a, _b, _c;
+  var _a, _b, _c, _d, _e, _f, _g, _h, _i;
   if (item === rest) return "...";
   const separateResult = separator.exec(item);
   if (separateResult == null ? void 0 : separateResult.groups) {
-    return [
-      {
-        type: "separator",
-        name: separateResult.groups.name
-      }
-    ];
+    const node = {
+      type: "separator",
+      name: separateResult.groups.name
+    };
+    return [(_c = (_b = (_a = ctx.options).attachSeparator) == null ? void 0 : _b.call(_a, node)) != null ? _c : node];
   }
   const linkResult = link.exec(item);
   if (linkResult == null ? void 0 : linkResult.groups) {
     const { url, text } = linkResult.groups;
     const isRelative = url.startsWith("/") || url.startsWith("#") || url.startsWith(".");
-    return [
-      {
-        type: "page",
-        name: text,
-        url,
-        external: !isRelative
-      }
-    ];
+    const node = {
+      type: "page",
+      name: text,
+      url,
+      external: !isRelative
+    };
+    return [(_f = (_e = (_d = ctx.options).attachFile) == null ? void 0 : _e.call(_d, node)) != null ? _f : node];
   }
   const extractResult = extractor.exec(item);
   const path = resolvePath(
     folder.file.path,
-    (_b = (_a = extractResult == null ? void 0 : extractResult.groups) == null ? void 0 : _a.name) != null ? _b : item
+    (_h = (_g = extractResult == null ? void 0 : extractResult.groups) == null ? void 0 : _g.name) != null ? _h : item
   );
-  const itemNode = (_c = ctx.storage.readDir(path)) != null ? _c : ctx.storage.read(path, "page");
+  const itemNode = (_i = ctx.storage.readDir(path)) != null ? _i : ctx.storage.read(path, "page");
   if (!itemNode) return [];
   addedNodePaths.add(itemNode.file.path);
   if ("children" in itemNode) {
@@ -124,7 +122,7 @@ function resolveFolderItem(folder, item, ctx, addedNodePaths) {
   return [buildFileNode(itemNode, ctx)];
 }
 function buildFolderNode(folder, defaultIsRoot, ctx) {
-  var _a, _b, _c, _d, _e, _f;
+  var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j;
   const metaPath = resolvePath(folder.file.path, "meta");
   let meta = ctx.storage.read(metaPath, "meta");
   meta = (_a = findLocalizedFile(metaPath, "meta", ctx)) != null ? _a : meta;
@@ -144,7 +142,7 @@ function buildFolderNode(folder, defaultIsRoot, ctx) {
       return resolveFolderItem(folder, item, ctx, addedNodePaths);
     });
     const restNodes = buildAll(
-      folder.children.filter((node) => !addedNodePaths.has(node.file.path)),
+      folder.children.filter((node2) => !addedNodePaths.has(node2.file.path)),
       ctx,
       !isRoot
     );
@@ -156,26 +154,33 @@ function buildFolderNode(folder, defaultIsRoot, ctx) {
     });
     children = nodes != null ? nodes : restNodes;
   }
-  return removeUndefined({
+  const node = {
     type: "folder",
     name: (_e = (_d = metadata == null ? void 0 : metadata.title) != null ? _d : index == null ? void 0 : index.name) != null ? _e : pathToName(folder.file.name),
-    icon: (_f = ctx.resolveIcon) == null ? void 0 : _f.call(ctx, metadata == null ? void 0 : metadata.icon),
+    icon: (_g = (_f = ctx.options).resolveIcon) == null ? void 0 : _g.call(_f, metadata == null ? void 0 : metadata.icon),
     root: metadata == null ? void 0 : metadata.root,
     defaultOpen: metadata == null ? void 0 : metadata.defaultOpen,
     index,
     children
-  });
+  };
+  if (ctx.options.attachFolderIds) {
+    node.id = folder.file.flattenedPath;
+  }
+  return removeUndefined(
+    (_j = (_i = (_h = ctx.options).attachFolder) == null ? void 0 : _i.call(_h, node, folder, meta)) != null ? _j : node
+  );
 }
 function buildFileNode(file, ctx) {
-  var _a, _b;
+  var _a, _b, _c, _d, _e, _f;
   const localized = (_a = findLocalizedFile(file.file.flattenedPath, "page", ctx)) != null ? _a : file;
   const data = localized.data;
-  return removeUndefined({
+  const item = {
     type: "page",
     name: data.data.title,
-    icon: (_b = ctx.resolveIcon) == null ? void 0 : _b.call(ctx, data.data.icon),
-    url: ctx.getUrl(data.slugs, ctx.lang)
-  });
+    icon: (_c = (_b = ctx.options).resolveIcon) == null ? void 0 : _c.call(_b, data.data.icon),
+    url: ctx.options.getUrl(data.slugs, ctx.lang)
+  };
+  return removeUndefined((_f = (_e = (_d = ctx.options).attachFile) == null ? void 0 : _e.call(_d, item, file)) != null ? _f : item);
 }
 function build(ctx) {
   const root = ctx.storage.root();
@@ -185,20 +190,24 @@ function build(ctx) {
     children: folder.children
   };
 }
-function createPageTreeBuilder(options) {
-  function getContext(builder, locale) {
-    return __spreadProps(__spreadValues({}, options), {
-      lang: locale,
-      builder
-    });
-  }
+function createPageTreeBuilder() {
   return {
-    build() {
-      return build(getContext(this));
+    build(options) {
+      return build({
+        options,
+        builder: this,
+        storage: options.storage
+      });
     },
-    buildI18n({ languages = [] } = {}) {
+    buildI18n(_a) {
+      var _b = _a, { languages = [] } = _b, options = __objRest(_b, ["languages"]);
       const entries = languages.map((lang) => {
-        const tree = build(getContext(this, lang));
+        const tree = build({
+          lang,
+          options,
+          builder: this,
+          storage: options.storage
+        });
         return [lang, tree];
       });
       return Object.fromEntries(entries);
@@ -349,13 +358,14 @@ function loader(options) {
 }
 function createOutput({
   source,
-  icon,
+  icon: resolveIcon,
   languages,
   rootDir = "",
   transformers,
   baseUrl = "/",
   slugs: slugsFn = getSlugs,
-  url: getUrl = createGetUrl(baseUrl)
+  url: getUrl = createGetUrl(baseUrl),
+  pageTree: pageTreeOptions = {}
 }) {
   const storage = loadFiles(
     typeof source.files === "function" ? source.files(rootDir) : source.files,
@@ -366,12 +376,17 @@ function createOutput({
     }
   );
   const i18nMap = buildPageMap(storage, languages != null ? languages : [], getUrl);
-  const builder = createPageTreeBuilder({
+  const builder = createPageTreeBuilder();
+  const pageTree = languages === void 0 ? builder.build(__spreadValues({
     storage,
-    resolveIcon: icon,
+    resolveIcon,
     getUrl
-  });
-  const pageTree = languages === void 0 ? builder.build() : builder.buildI18n({ languages });
+  }, pageTreeOptions)) : builder.buildI18n(__spreadValues({
+    languages,
+    storage,
+    resolveIcon,
+    getUrl
+  }, pageTreeOptions));
   return {
     pageTree,
     files: storage.list(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-core",
-  "version": "11.3.2",
+  "version": "12.0.0",
   "description": "The library for building a documentation website in Next.js",
   "keywords": [
     "NextJs",
@@ -113,8 +113,8 @@
   ],
   "dependencies": {
     "@formatjs/intl-localematcher": "^0.5.4",
-    "@shikijs/rehype": "^1.6.1",
-    "@shikijs/transformers": "^1.6.1",
+    "@shikijs/rehype": "^1.6.3",
+    "@shikijs/transformers": "^1.6.3",
     "flexsearch": "0.7.21",
     "github-slugger": "^2.0.0",
     "hast-util-to-estree": "^3.1.0",
@@ -125,7 +125,7 @@
     "remark-gfm": "^4.0.0",
     "remark-mdx": "^3.0.1",
     "scroll-into-view-if-needed": "^3.1.0",
-    "shiki": "^1.6.1",
+    "shiki": "^1.6.3",
     "swr": "^2.2.5",
     "unist-util-visit": "^5.0.0"
   },