fumadocs-core 16.8.12 → 16.9.1

package/dist/breadcrumb.d.ts

@@ -1,4 +1,4 @@
-import { i as Root, r as Node, t as Folder } from "./definitions-Cob-Q8-8.js";
+import { i as Root, r as Node, t as Folder } from "./definitions-DQRPsvc7.js";
 import { ReactNode } from "react";
 
 //#region src/breadcrumb.d.ts

package/dist/{definitions-Cob-Q8-8.d.ts → definitions-DQRPsvc7.d.ts}

@@ -9,9 +9,9 @@ interface ID {
 }
 interface Root extends ID {
   /**
-   * @internal meta file path
+   * @internal folder `$ref`
    */
-  $ref?: string;
+  $ref?: Folder['$ref'];
   type?: 'root';
   name: ReactNode;
   description?: ReactNode;
@@ -46,9 +46,12 @@ interface Separator extends ID {
 }
 interface Folder extends ID {
   /**
-   * @internal meta file path
+   * @internal paths of meta file & folder
    */
-  $ref?: string;
+  $ref?: {
+    meta?: string;
+    folder: string;
+  };
   type: 'folder';
   name: ReactNode;
   description?: ReactNode;

package/dist/i18n/index.d.ts

@@ -1,2 +1,2 @@
-import { n as defineI18n, t as I18nConfig } from "../index-BreFfl9v.js";
-export { I18nConfig, defineI18n };
+import { a as TranslationPreset, c as TranslationsAPIExtension, d as renderTranslation, i as TranslationObject, l as defineI18n, n as I18nConfig, o as TranslationValue, r as SingularTranslationsAPI, s as TranslationsAPI, t as I18nAPI, u as defineTranslations } from "../index-Ci-v40o3.js";
+export { I18nAPI, I18nConfig, SingularTranslationsAPI, TranslationObject, TranslationPreset, TranslationValue, TranslationsAPI, TranslationsAPIExtension, defineI18n, defineTranslations, renderTranslation };

package/dist/i18n/index.js

@@ -1,6 +1,83 @@
 //#region src/i18n/index.ts
 function defineI18n(config) {
-	return config;
+	return {
+		...config,
+		translations() {
+			const translations = {};
+			const stagedTranslations = {};
+			for (const lang of config.languages) {
+				translations[lang] = {};
+				stagedTranslations[lang] = {};
+			}
+			return {
+				config,
+				$inferLanguages: void 0,
+				$inferNamespaces: void 0,
+				get(lang) {
+					return translations[lang];
+				},
+				preset(lang, preset) {
+					const t = translations[lang];
+					const staged = stagedTranslations[lang];
+					for (const [namespace, obj] of Object.entries(preset.value)) Object.assign(t[namespace] ?? (staged[namespace] ??= {}), obj);
+					return this;
+				},
+				add(namespace, overrides) {
+					for (const [lang, values] of Object.entries(overrides)) Object.assign(translations[lang][namespace], values);
+					return this;
+				},
+				extend({ namespace, defaultValue }) {
+					for (const lang of config.languages) {
+						const t = translations[lang];
+						const staged = stagedTranslations[lang];
+						if (t[namespace]) continue;
+						t[namespace] = {
+							...defaultValue,
+							...staged[namespace]
+						};
+						delete staged[namespace];
+					}
+					return this;
+				}
+			};
+		}
+	};
+}
+/** create translations API without i18n */
+function defineTranslations() {
+	const translations = {};
+	const stagedTranslations = {};
+	return {
+		$inferNamespaces: void 0,
+		get() {
+			return translations;
+		},
+		preset(preset) {
+			for (const [namespace, obj] of Object.entries(preset.value)) {
+				const t = translations[namespace] ?? (stagedTranslations[namespace] ??= {});
+				Object.assign(t, obj);
+			}
+			return this;
+		},
+		add(namespace, overrides) {
+			Object.assign(translations[namespace], overrides);
+			return this;
+		},
+		extend({ namespace, defaultValue }) {
+			if (!translations[namespace]) {
+				translations[namespace] = {
+					...defaultValue,
+					...stagedTranslations[namespace]
+				};
+				delete stagedTranslations[namespace];
+			}
+			return this;
+		}
+	};
+}
+function renderTranslation(label, params) {
+	if (params) for (const k in params) label = label.replaceAll(`{${k}}`, params[k]);
+	return label;
 }
 //#endregion
-export { defineI18n };
+export { defineI18n, defineTranslations, renderTranslation };

package/dist/i18n/middleware.d.ts

@@ -1,4 +1,4 @@
-import { t as I18nConfig } from "../index-BreFfl9v.js";
+import { n as I18nConfig } from "../index-Ci-v40o3.js";
 import { NextProxy } from "next/server.js";
 import { NextURL } from "next/dist/server/web/next-url.js";
 

package/dist/{index-VMicRewG2.d.ts → index-8VAf9i7P2.d.ts}

@@ -1,8 +1,8 @@
-import { a as Separator, i as Root, n as Item, r as Node, t as Folder } from "./definitions-Cob-Q8-8.js";
+import { a as Separator, i as Root, n as Item, r as Node, t as Folder } from "./definitions-DQRPsvc7.js";
 import { t as Awaitable } from "./types-DpbpliNk.js";
 import { i as StructuredData } from "./remark-structure-C2-K9_ko.js";
-import { t as I18nConfig } from "./index-BreFfl9v.js";
-import { n as SerializedPageTree } from "./index-D2f_P1Zo.js";
+import { n as I18nConfig } from "./index-Ci-v40o3.js";
+import { n as SerializedPageTree } from "./index-Doj0FeGs.js";
 import { ReactNode } from "react";
 
 //#region src/source/storage/file-system.d.ts
@@ -55,15 +55,13 @@ interface ContentStoragePageFile<Type extends string | undefined = string | unde
 //#endregion
 //#region src/source/page-tree/builder.d.ts
 interface PageTreeBuilderContext<S extends ContentStorage = ContentStorage> {
-  idPrefix: string;
-  noRef: boolean;
   transformers: PageTreeTransformer<S>[];
   builder: PageTreeBuilder;
   storage: S;
-  getUrl: ResolvedLoaderConfig['url'];
   storages?: Record<string, S>;
   locale?: string;
   custom?: Record<string, unknown>;
+  options: PageTreeOptions<S>;
 }
 interface PageTreeTransformer<S extends ContentStorage = ContentStorage> {
   file?: (this: PageTreeBuilderContext<S>, node: Item, filePath?: string) => Item;
@@ -93,35 +91,15 @@ interface PageTreeOptions<S extends ContentStorage = ContentStorage> {
   transformers?: PageTreeTransformer<S>[];
   /** custom context */
   context?: Record<string, unknown>;
+  /** customize the default sorting behaviour (`localeCompare`) */
+  sort?: {
+    /** @default 'path' */by?: 'name' | 'path';
+    locales?: Intl.LocalesArgument;
+    options?: Intl.CollatorOptions;
+  };
 }
-declare class PageTreeBuilder {
-  private readonly flattenPathToFullPath;
-  private readonly transformers;
-  /** virtual file path -> output page tree node (if cached) */
-  private readonly pathToNode;
-  /** unfinished nodes */
-  private readonly unfinished;
-  private readonly ownerMap;
-  private _nextId;
-  /** passed as additional information to transformers */
-  private readonly ctx;
-  private readonly storage;
-  constructor(input: ContentStorage | [locale: string, storages: Record<string, ContentStorage>], options: PageTreeOptions);
+interface PageTreeBuilder {
   resolveFlattenPath(name: string, format: string): string;
-  /**
-   * try to register as the owner of `node`.
-   *
-   * when a node is referenced by multiple folders, this determines which folder they should belong to.
-   *
-   * @returns whether the owner owns the node.
-   */
-  private own;
-  private transferOwner;
-  private generateId;
-  buildPaths(paths: string[], filter?: (file: string) => boolean, reversed?: boolean): Node[];
-  private resolveFolderItem;
-  folder(folderPath: string): Folder | undefined;
-  file(path: string): Item | undefined;
   root(id?: string, path?: string): Root;
 }
 //#endregion
@@ -351,6 +329,7 @@ interface MetaData {
   title?: string | undefined;
   root?: boolean | undefined;
   pages?: string[] | undefined;
+  pagesIndex?: string | undefined;
   defaultOpen?: boolean | undefined;
   collapsible?: boolean | undefined;
   description?: string | undefined;

package/dist/{index-DRvW7IXg.d.ts → index-B_zmuyw1.d.ts}

@@ -1,4 +1,4 @@
-import { i as Root, n as Item, r as Node, t as Folder } from "./definitions-Cob-Q8-8.js";
+import { i as Root, n as Item, r as Node, t as Folder } from "./definitions-DQRPsvc7.js";
 
 //#region src/page-tree/utils.d.ts
 /**

package/dist/index-Ci-v40o3.d.ts

@@ -0,0 +1,87 @@
+//#region src/i18n/index.d.ts
+interface I18nConfig<Languages extends string = string> {
+  /**
+   * Supported locale codes.
+   *
+   * A page tree will be built for each language.
+   */
+  languages: Languages[];
+  /**
+   * Default locale if not specified
+   */
+  defaultLanguage: NoInfer<Languages>;
+  /**
+   * Don't show the locale prefix on URL.
+   *
+   * - `always`: Always hide the prefix
+   * - `default-locale`: Only hide the default locale
+   * - `never`: Never hide the prefix
+   *
+   * This API uses `NextResponse.rewrite`.
+   *
+   * @defaultValue 'never'
+   */
+  hideLocale?: 'always' | 'default-locale' | 'never';
+  /**
+   * Used by `loader()`, specify the way to parse i18n file structure.
+   *
+   * @defaultValue 'dot'
+   */
+  parser?: 'dot' | 'dir' | 'none';
+  /**
+   * the fallback language when the page has no translations available for a given locale.
+   *
+   * Default to `defaultLanguage`, no fallback when set to `null`.
+   */
+  fallbackLanguage?: NoInfer<Languages> | null;
+}
+interface I18nAPI<Languages extends string = string> extends I18nConfig<Languages> {
+  translations: () => TranslationsAPI<Languages, Record<never, TranslationObject>>;
+}
+declare function defineI18n<const Languages extends string>(config: I18nConfig<Languages>): I18nAPI<Languages>;
+type TranslationObject = Record<string, TranslationValue>;
+type TranslationValue<Params extends string = string> = string & {
+  _params?: Params;
+};
+type TranslationPreset<Namespaces extends Record<string, TranslationObject> = Record<string, TranslationObject>> = {
+  name: string;
+  value: Partial<Namespaces>;
+};
+interface TranslationsAPIExtension<Namespace extends string = string, Obj extends TranslationObject = TranslationObject> {
+  namespace: Namespace;
+  defaultValue: Obj;
+}
+interface TranslationsAPI<Languages extends string = string, Namespaces extends Record<string, TranslationObject> = Record<string, TranslationObject>> {
+  /** for type inference only, always `undefined` in runtime */
+  $inferLanguages: Languages;
+  /** for type inference only, always `undefined` in runtime */
+  $inferNamespaces: Namespaces;
+  config: I18nConfig<Languages>;
+  get: {
+    (lang: Languages): Namespaces;
+    (lang: string): Namespaces | undefined;
+  };
+  /** add extension, will be ignored if the same extension (namespace) has been registered */
+  extend: <N extends string, Obj extends TranslationObject>(extension: TranslationsAPIExtension<N, Obj>) => TranslationsAPI<Languages, Namespaces & { [K in N]: Obj }>;
+  /** add translations */
+  add: <N extends keyof Namespaces>(namespace: N, overrides: { [Lang in Languages]?: Partial<Namespaces[N]> }) => TranslationsAPI<Languages, Namespaces>;
+  /** add language pack */
+  preset: (lang: Languages, preset: TranslationPreset<Namespaces>) => TranslationsAPI<Languages, Namespaces>;
+}
+interface SingularTranslationsAPI<Namespaces extends Record<string, TranslationObject> = Record<string, TranslationObject>> {
+  /** for type inference only, always `undefined` in runtime */
+  $inferNamespaces: Namespaces;
+  get: () => Namespaces;
+  /** add extension, will be ignored if the same extension (namespace) has been registered */
+  extend: <N extends string, Obj extends TranslationObject>(extension: TranslationsAPIExtension<N, Obj>) => SingularTranslationsAPI<Namespaces & { [K in N]: Obj }>;
+  /** add translations */
+  add: <N extends keyof Namespaces>(namespace: N, overrides: Partial<Namespaces[N]>) => SingularTranslationsAPI<Namespaces>;
+  /** add language pack */
+  preset: (preset: TranslationPreset<Namespaces>) => SingularTranslationsAPI<Namespaces>;
+}
+/** create translations API without i18n */
+declare function defineTranslations(): SingularTranslationsAPI<Record<never, TranslationObject>>;
+declare function renderTranslation(v: TranslationValue<never>): string;
+declare function renderTranslation<Params extends string>(v: TranslationValue<Params>, params: Record<Params, string>): string;
+//#endregion
+export { TranslationPreset as a, TranslationsAPIExtension as c, renderTranslation as d, TranslationObject as i, defineI18n as l, I18nConfig as n, TranslationValue as o, SingularTranslationsAPI as r, TranslationsAPI as s, I18nAPI as t, defineTranslations as u };

package/dist/{index-D2f_P1Zo.d.ts → index-Doj0FeGs.d.ts}

@@ -1,4 +1,4 @@
-import { i as Root } from "./definitions-Cob-Q8-8.js";
+import { i as Root } from "./definitions-DQRPsvc7.js";
 //#region src/source/client/index.d.ts
 interface SerializedPageTree {
   $fumadocs_loader: 'page-tree';

package/dist/{loader-Bs2iumYD.js → loader-AC1aN-MX.js}

@@ -232,11 +232,9 @@ function transformerFallback() {
 				if (addedFiles.has(file)) continue;
 				isolatedStorage.write(file, this.storage.read(file));
 			}
-			root.fallback = new PageTreeBuilder(isolatedStorage, {
-				idPrefix: this.idPrefix ? `fallback:${this.idPrefix}` : "fallback",
-				url: this.getUrl,
-				noRef: this.noRef,
-				transformers: this.transformers,
+			root.fallback = createPageTreeBuilder(isolatedStorage, {
+				...this.options,
+				idPrefix: this.options.idPrefix ? `fallback:${this.options.idPrefix}` : "fallback",
 				generateFallback: false,
 				context: {
 					...this.custom,
@@ -267,40 +265,50 @@ const rest = "...";
 const restReversed = "z...a";
 const extractPrefix = "...";
 const excludePrefix = "!";
-var PageTreeBuilder = class {
-	constructor(input, options) {
-		this.flattenPathToFullPath = /* @__PURE__ */ new Map();
-		this.transformers = [];
-		this.pathToNode = /* @__PURE__ */ new Map();
-		this.unfinished = /* @__PURE__ */ new WeakSet();
-		this.ownerMap = /* @__PURE__ */ new Map();
-		this._nextId = 0;
-		const { transformers, url, context, generateFallback = true, idPrefix = "", noRef = false } = options;
-		if (transformers) this.transformers.push(...transformers);
-		if (generateFallback) this.transformers.push(transformerFallback());
-		this.ctx = {
-			builder: this,
-			idPrefix,
-			getUrl: url,
-			storage: void 0,
-			noRef,
-			transformers: this.transformers,
-			custom: context
+const SymbolUnfinished = Symbol("unfinished");
+const SymbolName = Symbol("name");
+const SymbolOwner = Symbol("owner");
+function createPageTreeBuilder(input, options) {
+	const flattenPathToFullPath = /* @__PURE__ */ new Map();
+	const transformers = [];
+	/** virtual file path -> output page tree node (if cached) */
+	const pathToNode = /* @__PURE__ */ new Map();
+	let _nextId = 0;
+	const { noRef = false, idPrefix, url: getUrl, generateFallback = true, sort: { by: sortBy = "path", locales: sortLocales, options: sortOptions } = {} } = options;
+	/** passed as additional information to transformers */
+	let ctx;
+	if (options.transformers) transformers.push(...options.transformers);
+	if (generateFallback) transformers.push(transformerFallback());
+	if (Array.isArray(input)) {
+		const [locale, storages] = input;
+		ctx = {
+			get builder() {
+				return builder;
+			},
+			storage: storages[locale],
+			storages,
+			locale,
+			transformers,
+			custom: options.context,
+			options
 		};
-		if (Array.isArray(input)) {
-			const [locale, storages] = input;
-			this.ctx.storage = this.storage = storages[locale];
-			this.ctx.locale = locale;
-			this.ctx.storages = storages;
-		} else this.ctx.storage = this.storage = input;
-		for (const file of this.storage.getFiles()) {
-			const content = this.storage.read(file);
-			const flattenPath = file.substring(0, file.length - extname(file).length);
-			this.flattenPathToFullPath.set(flattenPath + "." + content.format, file);
-		}
+	} else ctx = {
+		get builder() {
+			return builder;
+		},
+		storage: input,
+		transformers,
+		custom: options.context,
+		options
+	};
+	const { storage, locale } = ctx;
+	for (const file of storage.getFiles()) {
+		const content = storage.read(file);
+		const flattenPath = file.substring(0, file.length - extname(file).length);
+		flattenPathToFullPath.set(flattenPath + "." + content.format, file);
 	}
-	resolveFlattenPath(name, format) {
-		return this.flattenPathToFullPath.get(name + "." + format) ?? name;
+	function resolveFlattenPath(name, format) {
+		return flattenPathToFullPath.get(name + "." + format) ?? name;
 	}
 	/**
 	* try to register as the owner of `node`.
@@ -309,14 +317,14 @@ var PageTreeBuilder = class {
 	*
 	* @returns whether the owner owns the node.
 	*/
-	own(ownerPath, node, priority) {
-		if (this.unfinished.has(node)) return false;
-		const existing = this.ownerMap.get(node);
+	function own(ownerPath, node, priority) {
+		if (node[SymbolUnfinished]) return false;
+		const existing = node[SymbolOwner];
 		if (!existing) {
-			this.ownerMap.set(node, {
+			node[SymbolOwner] = {
 				owner: ownerPath,
 				priority
-			});
+			};
 			return true;
 		}
 		if (existing.owner === ownerPath) {
@@ -324,7 +332,7 @@ var PageTreeBuilder = class {
 			return true;
 		}
 		if (existing.priority >= priority) return false;
-		const folder = this.pathToNode.get(existing.owner);
+		const folder = pathToNode.get(existing.owner);
 		if (folder && folder.type === "folder") if (folder.index === node) delete folder.index;
 		else {
 			const idx = folder.children.indexOf(node);
@@ -334,113 +342,133 @@ var PageTreeBuilder = class {
 		existing.priority = priority;
 		return true;
 	}
-	transferOwner(ownerPath, node) {
-		const existing = this.ownerMap.get(node);
+	function transferOwner(ownerPath, node) {
+		const existing = node[SymbolOwner];
 		if (existing) existing.owner = ownerPath;
 	}
-	generateId(localId = `_${this._nextId++}`) {
+	function generateId(localId = `_${_nextId++}`) {
 		let id = localId;
-		if (this.ctx.locale) id = `${this.ctx.locale}:${id}`;
-		if (this.ctx.idPrefix) id = `${this.ctx.idPrefix}:${id}`;
+		if (locale) id = `${locale}:${id}`;
+		if (idPrefix) id = `${idPrefix}:${id}`;
 		return id;
 	}
-	buildPaths(paths, filter, reversed = false) {
-		const items = [];
-		const folders = [];
-		const sortedPaths = paths.sort((a, b) => reversed ? b.localeCompare(a) : a.localeCompare(b));
-		for (const path of sortedPaths) {
+	function buildPaths(paths, filter, reversed = false) {
+		const nodes = [];
+		let indexNode;
+		for (const path of paths) {
 			if (filter && !filter(path)) continue;
-			const fileNode = this.file(path);
+			const fileNode = buildFile(path);
 			if (fileNode) {
-				if (basename(path, extname(path)) === "index") items.unshift(fileNode);
-				else items.push(fileNode);
+				nodes.push(fileNode);
+				if (!indexNode && basename(path, extname(path)) === "index") indexNode = fileNode;
 				continue;
 			}
-			const dirNode = this.folder(path);
-			if (dirNode) folders.push(dirNode);
+			const dirNode = buildFolder(path);
+			if (dirNode) nodes.push(dirNode);
+		}
+		const factor = reversed ? -1 : 1;
+		const useName = sortBy === "name";
+		return nodes.sort((a, b) => {
+			if (a === indexNode) return -100;
+			if (b === indexNode) return 100;
+			const aT = useName && a[SymbolName] || (a.type === "folder" ? a.$ref.folder : a.$ref);
+			const bT = useName && b[SymbolName] || (b.type === "folder" ? b.$ref.folder : b.$ref);
+			const aK = a.type === "folder" ? 10 : 0;
+			const bK = b.type === "folder" ? 10 : 0;
+			return factor * (aT.localeCompare(bT, sortLocales, sortOptions) + (aK - bK));
+		});
+	}
+	function resolveLink(item) {
+		const match = link.exec(item);
+		if (!match?.groups) return;
+		const { icon, url, name, external } = match.groups;
+		let node = {
+			$id: generateId(),
+			type: "page",
+			icon,
+			name,
+			url,
+			external: external ? true : void 0
+		};
+		for (const transformer of transformers) {
+			if (!transformer.file) continue;
+			node = transformer.file.call(ctx, node);
 		}
-		items.push(...folders);
-		return items;
+		return node;
 	}
-	resolveFolderItem(folderPath, item, outputArray, excludedPaths) {
+	function resolveSeparator(item) {
+		const match = separator.exec(item);
+		if (!match?.groups) return;
+		let node = {
+			$id: generateId(),
+			type: "separator",
+			icon: match.groups.icon,
+			name: match.groups.name
+		};
+		for (const transformer of transformers) {
+			if (!transformer.separator) continue;
+			node = transformer.separator.call(ctx, node);
+		}
+		return node;
+	}
+	function resolveFolderItem(folderPath, item, outputArray, excludedPaths) {
 		if (item === rest || item === restReversed) {
 			outputArray.push(item);
 			return;
 		}
-		let match = separator.exec(item);
-		if (match?.groups) {
-			let node = {
-				$id: this.generateId(),
-				type: "separator",
-				icon: match.groups.icon,
-				name: match.groups.name
-			};
-			for (const transformer of this.transformers) {
-				if (!transformer.separator) continue;
-				node = transformer.separator.call(this.ctx, node);
-			}
-			outputArray.push(node);
+		const separator = resolveSeparator(item);
+		if (separator) {
+			outputArray.push(separator);
 			return;
 		}
-		match = link.exec(item);
-		if (match?.groups) {
-			const { icon, url, name, external } = match.groups;
-			let node = {
-				$id: this.generateId(),
-				type: "page",
-				icon,
-				name,
-				url
-			};
-			if (external) node.external = true;
-			for (const transformer of this.transformers) {
-				if (!transformer.file) continue;
-				node = transformer.file.call(this.ctx, node);
-			}
-			outputArray.push(node);
+		const link = resolveLink(item);
+		if (link) {
+			outputArray.push(link);
 			return;
 		}
 		if (item.startsWith(excludePrefix)) {
 			const path = joinPath(folderPath, item.slice(1));
 			excludedPaths.add(path);
-			excludedPaths.add(this.resolveFlattenPath(path, "page"));
+			excludedPaths.add(resolveFlattenPath(path, "page"));
 			return;
 		}
 		if (item.startsWith(extractPrefix)) {
 			const path = joinPath(folderPath, item.slice(3));
-			const node = this.folder(path);
+			const node = buildFolder(path);
 			if (!node) return;
 			const children = node.index ? [node.index, ...node.children] : node.children;
-			if (this.own(folderPath, node, 2)) {
+			if (own(folderPath, node, 2)) {
 				for (const child of children) {
-					this.transferOwner(folderPath, child);
+					transferOwner(folderPath, child);
 					outputArray.push(child);
 				}
 				excludedPaths.add(path);
-			} else for (const child of children) if (this.own(folderPath, child, 2)) outputArray.push(child);
+			} else for (const child of children) if (own(folderPath, child, 2)) outputArray.push(child);
 			return;
 		}
 		let path = joinPath(folderPath, item);
-		let node = this.folder(path);
+		let node = buildFolder(path);
 		if (!node) {
-			path = this.resolveFlattenPath(path, "page");
-			node = this.file(path);
+			path = resolveFlattenPath(path, "page");
+			node = buildFile(path);
 		}
-		if (!node || !this.own(folderPath, node, 2)) return;
+		if (!node || !own(folderPath, node, 2)) return;
 		outputArray.push(node);
 		excludedPaths.add(path);
 	}
-	folder(folderPath) {
-		const cached = this.pathToNode.get(folderPath);
+	function buildFolder(folderPath, isGlobalRoot = false) {
+		const cached = pathToNode.get(folderPath);
 		if (cached) return cached;
-		const files = this.storage.readDir(folderPath);
+		const files = storage.readDir(folderPath);
 		if (!files) return;
-		const isGlobalRoot = folderPath === "";
-		const metaPath = this.resolveFlattenPath(joinPath(folderPath, "meta"), "meta");
-		const indexPath = this.resolveFlattenPath(joinPath(folderPath, "index"), "page");
-		let meta = this.storage.read(metaPath);
-		if (meta && meta.format !== "meta") meta = void 0;
+		let metaPath = resolveFlattenPath(joinPath(folderPath, "meta"), "meta");
+		let meta = storage.read(metaPath);
+		if (!meta || meta.format !== "meta") {
+			meta = void 0;
+			metaPath = void 0;
+		}
 		const metadata = meta?.data ?? {};
+		const isRoot = metadata.root ?? isGlobalRoot;
 		let node = {
 			type: "folder",
 			name: null,
@@ -449,83 +477,109 @@ var PageTreeBuilder = class {
 			description: metadata.description,
 			collapsible: metadata.collapsible,
 			children: [],
-			$id: this.generateId(folderPath),
-			$ref: !this.ctx.noRef && meta ? metaPath : void 0
+			$id: generateId(folderPath),
+			$ref: {
+				folder: folderPath,
+				meta: metaPath
+			},
+			[SymbolUnfinished]: true
 		};
-		this.pathToNode.set(folderPath, node);
-		this.unfinished.add(node);
-		if (!(metadata.root ?? isGlobalRoot)) {
-			const file = this.file(indexPath);
-			if (file && this.own(folderPath, file, 0)) node.index = file;
+		pathToNode.set(folderPath, node);
+		let indexPath;
+		if (metadata.pagesIndex) {
+			const resolvedPath = resolveFlattenPath(joinPath(folderPath, metadata.pagesIndex), "page");
+			const page = buildFile(resolvedPath);
+			if (page && own(folderPath, page, 3)) {
+				indexPath = resolvedPath;
+				node.index = page;
+			} else node.index = resolveLink(metadata.pagesIndex);
+		} else if (!isRoot) {
+			const defaultPath = resolveFlattenPath(joinPath(folderPath, "index"), "page");
+			const page = buildFile(defaultPath);
+			if (page && own(folderPath, page, 0)) {
+				indexPath = defaultPath;
+				node.index = page;
+			}
 		}
 		if (metadata.pages) {
 			const outputArray = [];
 			const excludedPaths = /* @__PURE__ */ new Set();
-			for (const item of metadata.pages) this.resolveFolderItem(folderPath, item, outputArray, excludedPaths);
-			if (excludedPaths.has(indexPath)) delete node.index;
-			else if (node.index) excludedPaths.add(indexPath);
+			for (const item of metadata.pages) resolveFolderItem(folderPath, item, outputArray, excludedPaths);
+			if (indexPath) if (excludedPaths.has(indexPath)) delete node.index;
+			else excludedPaths.add(indexPath);
 			for (const item of outputArray) {
 				if (item !== rest && item !== restReversed) {
 					node.children.push(item);
 					continue;
 				}
-				const resolvedItem = this.buildPaths(files, (file) => !excludedPaths.has(file), item === restReversed);
-				for (const child of resolvedItem) if (this.own(folderPath, child, 0)) node.children.push(child);
+				const resolvedItem = buildPaths(files, (file) => !excludedPaths.has(file), item === restReversed);
+				for (const child of resolvedItem) if (own(folderPath, child, 0)) node.children.push(child);
 			}
-		} else for (const item of this.buildPaths(files, node.index ? (file) => file !== indexPath : void 0)) if (this.own(folderPath, item, 0)) node.children.push(item);
+		} else for (const item of buildPaths(files, indexPath ? (file) => file !== indexPath : void 0)) if (own(folderPath, item, 0)) node.children.push(item);
 		node.icon = metadata.icon ?? node.index?.icon;
 		node.name = metadata.title ?? node.index?.name;
-		this.unfinished.delete(node);
+		node[SymbolName] = metadata.title ?? node.index?.[SymbolName];
 		if (!node.name) {
 			const folderName = basename(folderPath);
 			node.name = pathToName(group.exec(folderName)?.[1] ?? folderName);
 		}
-		for (const transformer of this.transformers) {
+		for (const transformer of transformers) {
 			if (!transformer.folder) continue;
-			node = transformer.folder.call(this.ctx, node, folderPath, meta ? metaPath : void 0);
+			node = transformer.folder.call(ctx, node, folderPath, metaPath);
 		}
-		this.pathToNode.set(folderPath, node);
+		pathToNode.set(folderPath, node);
+		delete node[SymbolUnfinished];
 		return node;
 	}
-	file(path) {
-		const cached = this.pathToNode.get(path);
+	function buildFile(path) {
+		const cached = pathToNode.get(path);
 		if (cached) return cached;
-		const page = this.storage.read(path);
+		const page = storage.read(path);
 		if (!page || page.format !== "page") return;
 		const { title, description, icon } = page.data;
 		let item = {
-			$id: this.generateId(path),
+			$id: generateId(path),
 			type: "page",
 			name: title ?? pathToName(basename(path, extname(path))),
 			description,
 			icon,
-			url: this.ctx.getUrl(page.slugs, this.ctx.locale),
-			$ref: !this.ctx.noRef ? path : void 0
+			url: getUrl(page.slugs, ctx.locale),
+			$ref: path,
+			[SymbolName]: title
 		};
-		for (const transformer of this.transformers) {
+		for (const transformer of transformers) {
 			if (!transformer.file) continue;
-			item = transformer.file.call(this.ctx, item, path);
+			item = transformer.file.call(ctx, item, path);
 		}
-		this.pathToNode.set(path, item);
+		pathToNode.set(path, item);
 		return item;
 	}
-	root(id = "root", path = "") {
-		const folder = this.folder(path);
-		let root = {
-			type: "root",
-			$ref: folder?.$ref,
-			$id: this.generateId(id),
-			name: folder?.name || "Docs",
-			description: folder?.description,
-			children: folder ? folder.children : []
-		};
-		for (const transformer of this.transformers) {
-			if (!transformer.root) continue;
-			root = transformer.root.call(this.ctx, root);
+	const builder = {
+		resolveFlattenPath,
+		root(id = "root", path = "") {
+			const folder = buildFolder(path, true);
+			for (const node of pathToNode.values()) {
+				delete node[SymbolName];
+				delete node[SymbolOwner];
+				if (noRef && "$ref" in node) delete node.$ref;
+			}
+			let root = {
+				type: "root",
+				$ref: folder?.$ref,
+				$id: generateId(id),
+				name: folder?.name || "Docs",
+				description: folder?.description,
+				children: folder ? folder.children : []
+			};
+			for (const transformer of transformers) {
+				if (!transformer.root) continue;
+				root = transformer.root.call(ctx, root);
+			}
+			return root;
 		}
-		return root;
-	}
-};
+	};
+	return builder;
+}
 /**
 * Get item name from file name
 *
@@ -623,10 +677,10 @@ function loader(...args) {
 			...pageTreeConfig,
 			transformers
 		};
-		if (storage instanceof FileSystem) return pageTrees = new PageTreeBuilder(storage, options).root();
+		if (storage instanceof FileSystem) return pageTrees = createPageTreeBuilder(storage, options).root();
 		else {
 			const out = {};
-			for (const locale in storage) out[locale] = new PageTreeBuilder([locale, storage], options).root();
+			for (const locale in storage) out[locale] = createPageTreeBuilder([locale, storage], options).root();
 			return pageTrees = out;
 		}
 	}
@@ -677,8 +731,8 @@ function loader(...args) {
 		},
 		getNodeMeta(node, language = i18n?.defaultLanguage) {
 			const ref = node.$ref;
-			if (!ref) return;
-			return indexer.getMeta(ref, language);
+			if (!ref?.meta) return;
+			return indexer.getMeta(ref.meta, language);
 		},
 		getNodePage(node, language = i18n?.defaultLanguage) {
 			const ref = node.$ref;

package/dist/page-tree/index.d.ts

@@ -1,3 +1,3 @@
-import { a as Separator, i as Root, n as Item, r as Node, t as Folder } from "../definitions-Cob-Q8-8.js";
-import { a as flattenTree, c as visit, i as findSiblings, n as findParent, o as getPageTreePeers, r as findPath, s as getPageTreeRoots, t as findNeighbour } from "../index-DRvW7IXg.js";
+import { a as Separator, i as Root, n as Item, r as Node, t as Folder } from "../definitions-DQRPsvc7.js";
+import { a as flattenTree, c as visit, i as findSiblings, n as findParent, o as getPageTreePeers, r as findPath, s as getPageTreeRoots, t as findNeighbour } from "../index-B_zmuyw1.js";
 export { Folder, Item, Node, Root, Separator, findNeighbour, findParent, findPath, findSiblings, flattenTree, getPageTreePeers, getPageTreeRoots, visit };

package/dist/search/flexsearch.d.ts

@@ -1,7 +1,7 @@
 import { t as Awaitable } from "../types-DpbpliNk.js";
-import { t as I18nConfig } from "../index-BreFfl9v.js";
-import { m as SharedIndex, n as SearchAPI, t as QueryOptions } from "../server-CQJ8bzkB.js";
-import { C as LoaderConfig, T as LoaderOutput } from "../index-VMicRewG2.js";
+import { n as I18nConfig } from "../index-Ci-v40o3.js";
+import { m as SharedIndex, n as SearchAPI, t as QueryOptions } from "../server-CB8UVhSB.js";
+import { C as LoaderConfig, T as LoaderOutput } from "../index-8VAf9i7P2.js";
 import { DocumentData, DocumentOptions } from "flexsearch";
 
 //#region src/search/server/build-doc.d.ts

package/dist/search/mixedbread.d.ts

@@ -1,5 +1,5 @@
 import { r as SortedResult } from "../index-Bcms_L7o.js";
-import { n as SearchAPI } from "../server-CQJ8bzkB.js";
+import { n as SearchAPI } from "../server-CB8UVhSB.js";
 import Mixedbread from "@mixedbread/sdk";
 import { StoreSearchResponse } from "@mixedbread/sdk/resources/stores";
 

package/dist/search/server.d.ts

@@ -1,2 +1,2 @@
-import { a as AdvancedOptions, c as SimpleOptions, d as createSearchAPI, f as initAdvancedSearch, i as AdvancedIndex, l as createFromSource, n as SearchAPI, o as ExportedData, p as initSimpleSearch, r as SearchServer, s as Index, t as QueryOptions, u as createI18nSearchAPI } from "../server-CQJ8bzkB.js";
+import { a as AdvancedOptions, c as SimpleOptions, d as createSearchAPI, f as initAdvancedSearch, i as AdvancedIndex, l as createFromSource, n as SearchAPI, o as ExportedData, p as initSimpleSearch, r as SearchServer, s as Index, t as QueryOptions, u as createI18nSearchAPI } from "../server-CB8UVhSB.js";
 export { AdvancedIndex, AdvancedOptions, ExportedData, Index, QueryOptions, SearchAPI, SearchServer, SimpleOptions, createFromSource, createI18nSearchAPI, createSearchAPI, initAdvancedSearch, initSimpleSearch };

package/dist/{server-CQJ8bzkB.d.ts → server-CB8UVhSB.d.ts}

@@ -1,8 +1,8 @@
 import { t as Awaitable } from "./types-DpbpliNk.js";
 import { i as StructuredData } from "./remark-structure-C2-K9_ko.js";
-import { t as I18nConfig } from "./index-BreFfl9v.js";
+import { n as I18nConfig } from "./index-Ci-v40o3.js";
 import { r as SortedResult } from "./index-Bcms_L7o.js";
-import { C as LoaderConfig, T as LoaderOutput } from "./index-VMicRewG2.js";
+import { C as LoaderConfig, T as LoaderOutput } from "./index-8VAf9i7P2.js";
 import { Language, Orama, RawData, SearchParams, TypedDocument, create } from "@orama/orama";
 
 //#region src/search/orama/create-db.d.ts

package/dist/source/client/index.d.ts

@@ -1,2 +1,2 @@
-import { i as useFumadocsLoader, n as SerializedPageTree, r as deserializePageTree, t as Serialized } from "../../index-D2f_P1Zo.js";
+import { i as useFumadocsLoader, n as SerializedPageTree, r as deserializePageTree, t as Serialized } from "../../index-Doj0FeGs.js";
 export { Serialized, SerializedPageTree, deserializePageTree, useFumadocsLoader };

package/dist/source/dynamic.d.ts

@@ -1,2 +1,2 @@
-import { b as dynamicLoader, v as DynamicLoader, y as DynamicLoaderConfig } from "../index-VMicRewG2.js";
+import { b as dynamicLoader, v as DynamicLoader, y as DynamicLoaderConfig } from "../index-8VAf9i7P2.js";
 export { DynamicLoader, DynamicLoaderConfig, dynamicLoader };

package/dist/source/dynamic.js

@@ -1,4 +1,4 @@
-import { i as isStaticSource, n as loader, r as isDynamicSource } from "../loader-Bs2iumYD.js";
+import { i as isStaticSource, n as loader, r as isDynamicSource } from "../loader-AC1aN-MX.js";
 import { cache } from "react";
 //#region src/source/dynamic.ts
 function dynamicLoader(input, options) {

package/dist/source/index.d.ts

@@ -1,2 +1,2 @@
-import { A as ResolvedLoaderConfig, B as PageTreeTransformer, C as LoaderConfig, D as LoaderPluginOption, E as LoaderPlugin, H as ContentStorageMetaFile, L as PageTreeBuilder, M as loader, O as Meta, P as getSlugs, R as PageTreeBuilderContext, S as InferPageType, T as LoaderOutput, U as ContentStoragePageFile, V as ContentStorage, W as FileSystem, _ as update, a as MetaData, c as SourceConfig, d as VirtualFile, f as _SourceUpdate_, g as source, h as multiple, i as DynamicSource, j as createGetUrl, k as Page, l as SourceUnion, m as isStaticSource, n as llms, o as PageData, p as isDynamicSource, r as path_d_exports, s as Source, t as LLMsConfig, u as StaticSource, w as LoaderOptions, x as InferMetaType, z as PageTreeOptions } from "../index-VMicRewG2.js";
+import { A as ResolvedLoaderConfig, B as PageTreeTransformer, C as LoaderConfig, D as LoaderPluginOption, E as LoaderPlugin, H as ContentStorageMetaFile, L as PageTreeBuilder, M as loader, O as Meta, P as getSlugs, R as PageTreeBuilderContext, S as InferPageType, T as LoaderOutput, U as ContentStoragePageFile, V as ContentStorage, W as FileSystem, _ as update, a as MetaData, c as SourceConfig, d as VirtualFile, f as _SourceUpdate_, g as source, h as multiple, i as DynamicSource, j as createGetUrl, k as Page, l as SourceUnion, m as isStaticSource, n as llms, o as PageData, p as isDynamicSource, r as path_d_exports, s as Source, t as LLMsConfig, u as StaticSource, w as LoaderOptions, x as InferMetaType, z as PageTreeOptions } from "../index-8VAf9i7P2.js";
 export { ContentStorage, ContentStorageMetaFile, ContentStoragePageFile, DynamicSource, FileSystem, InferMetaType, InferPageType, LLMsConfig, LoaderConfig, LoaderOptions, LoaderOutput, LoaderPlugin, LoaderPluginOption, Meta, MetaData, Page, PageData, PageTreeBuilder, PageTreeBuilderContext, PageTreeOptions, PageTreeTransformer, path_d_exports as PathUtils, ResolvedLoaderConfig, Source, SourceConfig, SourceUnion, StaticSource, VirtualFile, _SourceUpdate_, createGetUrl, getSlugs, isDynamicSource, isStaticSource, llms, loader, multiple, source, update };

package/dist/source/index.js

@@ -1,5 +1,5 @@
 import { o as path_exports } from "../path-CPgAF5cw.js";
-import { a as multiple, c as FileSystem, i as isStaticSource, n as loader, o as source, r as isDynamicSource, s as update, t as createGetUrl } from "../loader-Bs2iumYD.js";
+import { a as multiple, c as FileSystem, i as isStaticSource, n as loader, o as source, r as isDynamicSource, s as update, t as createGetUrl } from "../loader-AC1aN-MX.js";
 import { getSlugs } from "./plugins/slugs.js";
 import { llms } from "./llms.js";
 export { FileSystem, path_exports as PathUtils, createGetUrl, getSlugs, isDynamicSource, isStaticSource, llms, loader, multiple, source, update };

package/dist/source/llms.d.ts

@@ -1,2 +1,2 @@
-import { n as llms, t as LLMsConfig } from "../index-VMicRewG2.js";
+import { n as llms, t as LLMsConfig } from "../index-8VAf9i7P2.js";
 export { LLMsConfig, llms };

package/dist/source/plugins/lucide-icons.d.ts

@@ -1,4 +1,4 @@
-import { E as LoaderPlugin } from "../../index-VMicRewG2.js";
+import { E as LoaderPlugin } from "../../index-8VAf9i7P2.js";
 import { icons } from "lucide-react";
 
 //#region src/source/plugins/lucide-icons.d.ts

package/dist/source/plugins/slugs.d.ts

@@ -1,2 +1,2 @@
-import { F as slugsFromData, I as slugsPlugin, N as SlugFn, P as getSlugs } from "../../index-VMicRewG2.js";
+import { F as slugsFromData, I as slugsPlugin, N as SlugFn, P as getSlugs } from "../../index-8VAf9i7P2.js";
 export { SlugFn, getSlugs, slugsFromData, slugsPlugin };

package/dist/source/plugins/status-badges.d.ts

@@ -1,5 +1,5 @@
-import { a as Separator$1, n as Item$1, t as Folder$1 } from "../../definitions-Cob-Q8-8.js";
-import { E as LoaderPlugin } from "../../index-VMicRewG2.js";
+import { a as Separator$1, n as Item$1, t as Folder$1 } from "../../definitions-DQRPsvc7.js";
+import { E as LoaderPlugin } from "../../index-8VAf9i7P2.js";
 import { ReactNode } from "react";
 
 //#region src/source/plugins/status-badges.d.ts

package/dist/source/schema.d.ts

@@ -7,6 +7,7 @@ import { z } from "zod";
 declare const metaSchema: z.ZodObject<{
   title: z.ZodOptional<z.ZodString>;
   pages: z.ZodOptional<z.ZodArray<z.ZodString>>;
+  pagesIndex: z.ZodOptional<z.ZodString>;
   description: z.ZodOptional<z.ZodString>;
   root: z.ZodOptional<z.ZodBoolean>;
   defaultOpen: z.ZodOptional<z.ZodBoolean>;

package/dist/source/schema.js

@@ -6,6 +6,8 @@ import { z } from "zod";
 const metaSchema = z.object({
 	title: z.string().optional(),
 	pages: z.array(z.string()).optional(),
+	/** specify a index page for folder */
+	pagesIndex: z.string().optional(),
 	description: z.string().optional(),
 	root: z.boolean().optional(),
 	defaultOpen: z.boolean().optional(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-core",
-  "version": "16.8.12",
+  "version": "16.9.1",
   "description": "The React.js library for building a documentation website",
   "keywords": [
     "Docs",

package/dist/index-BreFfl9v.d.ts

@@ -1,40 +0,0 @@
-//#region src/i18n/index.d.ts
-interface I18nConfig<Languages extends string = string> {
-  /**
-   * Supported locale codes.
-   *
-   * A page tree will be built for each language.
-   */
-  languages: Languages[];
-  /**
-   * Default locale if not specified
-   */
-  defaultLanguage: Languages;
-  /**
-   * Don't show the locale prefix on URL.
-   *
-   * - `always`: Always hide the prefix
-   * - `default-locale`: Only hide the default locale
-   * - `never`: Never hide the prefix
-   *
-   * This API uses `NextResponse.rewrite`.
-   *
-   * @defaultValue 'never'
-   */
-  hideLocale?: 'always' | 'default-locale' | 'never';
-  /**
-   * Used by `loader()`, specify the way to parse i18n file structure.
-   *
-   * @defaultValue 'dot'
-   */
-  parser?: 'dot' | 'dir' | 'none';
-  /**
-   * the fallback language when the page has no translations available for a given locale.
-   *
-   * Default to `defaultLanguage`, no fallback when set to `null`.
-   */
-  fallbackLanguage?: Languages | null;
-}
-declare function defineI18n<Languages extends string>(config: I18nConfig<Languages>): I18nConfig<Languages>;
-//#endregion
-export { defineI18n as n, I18nConfig as t };