fumadocs-mdx 11.8.0 → 11.8.2

package/dist/build-mdx-DnC1jKvn.d.cts

@@ -0,0 +1,46 @@
+import { createProcessor } from '@mdx-js/mdx';
+import { StructuredData } from 'fumadocs-core/mdx-plugins';
+import { TableOfContents } from 'fumadocs-core/server';
+import { FC } from 'react';
+import { MDXProps } from 'mdx/types';
+
+declare module 'vfile' {
+    interface DataMap {
+        extractedReferences: ExtractedReference[];
+    }
+}
+interface ExtractedReference {
+    href: string;
+}
+
+type Processor = ReturnType<typeof createProcessor>;
+interface CompilerOptions {
+    addDependency: (file: string) => void;
+}
+interface CompiledMDXProperties<Frontmatter = Record<string, unknown>> {
+    frontmatter: Frontmatter;
+    structuredData: StructuredData;
+    toc: TableOfContents;
+    default: FC<MDXProps>;
+    /**
+     * Only available when `lastModifiedTime` is enabled on MDX loader
+     */
+    lastModified?: Date;
+    extractedReferences?: ExtractedReference[];
+}
+
+declare module 'vfile' {
+    interface DataMap {
+        /**
+         * [Fumadocs MDX] raw frontmatter, you can modify it
+         */
+        frontmatter?: Record<string, unknown>;
+        /**
+         * [Fumadocs MDX] The compiler object from loader
+         */
+        _compiler?: CompilerOptions;
+        _getProcessor?: (format: 'md' | 'mdx') => Processor;
+    }
+}
+
+export type { CompiledMDXProperties as C };

package/dist/build-mdx-DnC1jKvn.d.ts

@@ -0,0 +1,46 @@
+import { createProcessor } from '@mdx-js/mdx';
+import { StructuredData } from 'fumadocs-core/mdx-plugins';
+import { TableOfContents } from 'fumadocs-core/server';
+import { FC } from 'react';
+import { MDXProps } from 'mdx/types';
+
+declare module 'vfile' {
+    interface DataMap {
+        extractedReferences: ExtractedReference[];
+    }
+}
+interface ExtractedReference {
+    href: string;
+}
+
+type Processor = ReturnType<typeof createProcessor>;
+interface CompilerOptions {
+    addDependency: (file: string) => void;
+}
+interface CompiledMDXProperties<Frontmatter = Record<string, unknown>> {
+    frontmatter: Frontmatter;
+    structuredData: StructuredData;
+    toc: TableOfContents;
+    default: FC<MDXProps>;
+    /**
+     * Only available when `lastModifiedTime` is enabled on MDX loader
+     */
+    lastModified?: Date;
+    extractedReferences?: ExtractedReference[];
+}
+
+declare module 'vfile' {
+    interface DataMap {
+        /**
+         * [Fumadocs MDX] raw frontmatter, you can modify it
+         */
+        frontmatter?: Record<string, unknown>;
+        /**
+         * [Fumadocs MDX] The compiler object from loader
+         */
+        _compiler?: CompilerOptions;
+        _getProcessor?: (format: 'md' | 'mdx') => Processor;
+    }
+}
+
+export type { CompiledMDXProperties as C };

package/dist/{chunk-XZR5QXVY.js → chunk-BWRDVK5L.js}

@@ -1,6 +1,6 @@
 import {
   buildConfig
-} from "./chunk-XVL4ZQFK.js";
+} from "./chunk-QVZ7JH4H.js";
 
 // src/utils/config.ts
 import * as fs from "fs/promises";

package/dist/{chunk-7JFPDRW7.js → chunk-QQWCBFFE.js}

@@ -1,6 +1,6 @@
 import {
   remarkInclude
-} from "./chunk-IGXZS2W6.js";
+} from "./chunk-SVTXMVLQ.js";
 
 // src/utils/build-mdx.ts
 import { createProcessor } from "@mdx-js/mdx";
@@ -30,9 +30,7 @@ async function buildMDX(cacheKey, source, options) {
       ...data,
       frontmatter,
       _compiler,
-      _processor: {
-        getProcessor
-      }
+      _getProcessor: getProcessor
     }
   });
 }

package/dist/{chunk-XVL4ZQFK.js → chunk-QVZ7JH4H.js}

@@ -34,7 +34,7 @@ function buildConfig(config) {
       const input = this.global.mdxOptions;
       async function uncached() {
         const options = typeof input === "function" ? await input() : input;
-        const { getDefaultMDXOptions } = await import("./mdx-options-3NB74EMB.js");
+        const { getDefaultMDXOptions } = await import("./mdx-options-T73E4LQB.js");
         if (options?.preset === "minimal") return options;
         return getDefaultMDXOptions({
           ...options,

package/dist/{chunk-GYWPPGFD.js → chunk-SMSNZ6N5.js}

@@ -1,16 +1,42 @@
 // src/utils/mdx-options.ts
 import * as plugins from "fumadocs-core/mdx-plugins";
 
-// src/mdx-plugins/remark-exports.ts
+// src/mdx-plugins/remark-postprocess.ts
+import { visit } from "unist-util-visit";
 import { valueToEstree } from "estree-util-value-to-estree";
-function remarkMdxExport({ values }) {
-  return (tree, vfile) => {
-    for (const name of values) {
-      if (!(name in vfile.data)) return;
-      tree.children.unshift(getMdastExport(name, vfile.data[name]));
+function remarkPostprocess({
+  injectExports
+}) {
+  return (tree, file) => {
+    let title;
+    const urls = [];
+    visit(tree, ["heading", "link"], (node) => {
+      if (node.type === "heading" && node.depth === 1) {
+        title = flattenNode(node);
+      }
+      if (node.type !== "link") return;
+      urls.push({
+        href: node.url
+      });
+      return "skip";
+    });
+    if (title) {
+      file.data.frontmatter ??= {};
+      if (!file.data.frontmatter.title) file.data.frontmatter.title = title;
+    }
+    file.data.extractedReferences = urls;
+    for (const name of injectExports) {
+      if (!(name in file.data)) continue;
+      tree.children.unshift(getMdastExport(name, file.data[name]));
     }
   };
 }
+function flattenNode(node) {
+  if ("children" in node)
+    return node.children.map((child) => flattenNode(child)).join("");
+  if ("value" in node) return node.value;
+  return "";
+}
 function getMdastExport(name, value) {
   return {
     type: "mdxjsEsm",
@@ -22,6 +48,7 @@ function getMdastExport(name, value) {
         body: [
           {
             type: "ExportNamedDeclaration",
+            attributes: [],
             specifiers: [],
             source: null,
             declaration: {
@@ -68,6 +95,7 @@ function getDefaultMDXOptions({
 }) {
   const mdxExports = [
     "structuredData",
+    "extractedReferences",
     "frontmatter",
     "lastModified",
     ...valueToExport
@@ -99,7 +127,10 @@ function getDefaultMDXOptions({
         plugins.remarkStructure,
         remarkStructureOptions
       ],
-      [remarkMdxExport, { values: mdxExports }]
+      [
+        remarkPostprocess,
+        { injectExports: mdxExports }
+      ]
     ],
     mdxOptions.remarkPlugins
   );

package/dist/chunk-SVTXMVLQ.js

@@ -0,0 +1,139 @@
+import {
+  fumaMatter
+} from "./chunk-VWJKRQZR.js";
+
+// src/mdx-plugins/remark-include.ts
+import { unified } from "unified";
+import { visit } from "unist-util-visit";
+import * as path from "path";
+import * as fs from "fs/promises";
+import remarkParse from "remark-parse";
+import remarkMdx from "remark-mdx";
+import { remarkHeading } from "fumadocs-core/mdx-plugins";
+var baseProcessor = unified().use(remarkHeading);
+function flattenNode(node) {
+  if ("children" in node)
+    return node.children.map((child) => flattenNode(child)).join("");
+  if ("value" in node) return node.value;
+  return "";
+}
+function parseSpecifier(specifier) {
+  const idx = specifier.lastIndexOf("#");
+  if (idx === -1) return { file: specifier };
+  return {
+    file: specifier.slice(0, idx),
+    section: specifier.slice(idx + 1)
+  };
+}
+function extractSection(root, section) {
+  let nodes;
+  for (const node of root.children) {
+    if (node.type === "mdxJsxFlowElement" && node.name === "section" && node.attributes.some(
+      (attr) => attr.type === "mdxJsxAttribute" && attr.name === "id" && attr.value === section
+    )) {
+      nodes = node.children;
+      break;
+    }
+    if (node.type === "heading" && node.data?.hProperties?.id === section) {
+      nodes = [node];
+      continue;
+    }
+    if (!nodes) continue;
+    if (node.type === "heading") break;
+    nodes.push(node);
+  }
+  if (nodes)
+    return {
+      type: "root",
+      children: nodes
+    };
+}
+function remarkInclude() {
+  const TagName = "include";
+  async function embedContent(file, heading, params, data) {
+    let content;
+    try {
+      content = (await fs.readFile(file)).toString();
+    } catch (e) {
+      throw new Error(
+        `failed to read file ${file}
+${e instanceof Error ? e.message : String(e)}`,
+        { cause: e }
+      );
+    }
+    const ext = path.extname(file);
+    data._compiler?.addDependency(file);
+    if (params.lang || ext !== ".md" && ext !== ".mdx") {
+      const lang = params.lang ?? ext.slice(1);
+      return {
+        type: "code",
+        lang,
+        meta: params.meta,
+        value: content,
+        data: {}
+      };
+    }
+    const processor = (data._getProcessor ?? getDefaultProcessor)(
+      ext === ".mdx" ? "mdx" : "md"
+    );
+    let parsed = await baseProcessor.run(
+      processor.parse(fumaMatter(content).content)
+    );
+    if (heading) {
+      const extracted = extractSection(parsed, heading);
+      if (!extracted)
+        throw new Error(
+          `Cannot find section ${heading} in ${file}, make sure you have encapsulated the section in a <section id="${heading}"> tag.`
+        );
+      parsed = extracted;
+    }
+    await update(parsed, path.dirname(file), data);
+    return parsed;
+  }
+  async function update(tree, directory, data) {
+    const queue = [];
+    visit(
+      tree,
+      ["mdxJsxFlowElement", "mdxJsxTextElement"],
+      (_node, _, parent) => {
+        const node = _node;
+        if (node.name !== TagName) return;
+        const params = {};
+        const specifier = flattenNode(node);
+        if (specifier.length === 0) return "skip";
+        for (const attr of node.attributes) {
+          if (attr.type === "mdxJsxAttribute" && (typeof attr.value === "string" || attr.value === null)) {
+            params[attr.name] = attr.value;
+          }
+        }
+        const { file: relativePath, section } = parseSpecifier(specifier);
+        const file = path.resolve(
+          "cwd" in params ? process.cwd() : directory,
+          relativePath
+        );
+        queue.push(
+          embedContent(file, section, params, data).then((replace) => {
+            Object.assign(
+              parent && parent.type === "paragraph" ? parent : node,
+              replace
+            );
+          })
+        );
+        return "skip";
+      }
+    );
+    await Promise.all(queue);
+  }
+  return async (tree, file) => {
+    await update(tree, path.dirname(file.path), file.data);
+  };
+}
+function getDefaultProcessor(format) {
+  const mdProcessor = unified().use(remarkParse);
+  if (format === "md") return mdProcessor;
+  return mdProcessor.use(remarkMdx);
+}
+
+export {
+  remarkInclude
+};

package/dist/config/index.cjs

@@ -93,16 +93,42 @@ function defineConfig(config = {}) {
 // src/utils/mdx-options.ts
 var plugins = __toESM(require("fumadocs-core/mdx-plugins"), 1);
 
-// src/mdx-plugins/remark-exports.ts
+// src/mdx-plugins/remark-postprocess.ts
+var import_unist_util_visit = require("unist-util-visit");
 var import_estree_util_value_to_estree = require("estree-util-value-to-estree");
-function remarkMdxExport({ values }) {
-  return (tree, vfile) => {
-    for (const name of values) {
-      if (!(name in vfile.data)) return;
-      tree.children.unshift(getMdastExport(name, vfile.data[name]));
+function remarkPostprocess({
+  injectExports
+}) {
+  return (tree, file) => {
+    let title;
+    const urls = [];
+    (0, import_unist_util_visit.visit)(tree, ["heading", "link"], (node) => {
+      if (node.type === "heading" && node.depth === 1) {
+        title = flattenNode(node);
+      }
+      if (node.type !== "link") return;
+      urls.push({
+        href: node.url
+      });
+      return "skip";
+    });
+    if (title) {
+      file.data.frontmatter ??= {};
+      if (!file.data.frontmatter.title) file.data.frontmatter.title = title;
+    }
+    file.data.extractedReferences = urls;
+    for (const name of injectExports) {
+      if (!(name in file.data)) continue;
+      tree.children.unshift(getMdastExport(name, file.data[name]));
     }
   };
 }
+function flattenNode(node) {
+  if ("children" in node)
+    return node.children.map((child) => flattenNode(child)).join("");
+  if ("value" in node) return node.value;
+  return "";
+}
 function getMdastExport(name, value) {
   return {
     type: "mdxjsEsm",
@@ -114,6 +140,7 @@ function getMdastExport(name, value) {
         body: [
           {
             type: "ExportNamedDeclaration",
+            attributes: [],
             specifiers: [],
             source: null,
             declaration: {
@@ -160,6 +187,7 @@ function getDefaultMDXOptions({
 }) {
   const mdxExports = [
     "structuredData",
+    "extractedReferences",
     "frontmatter",
     "lastModified",
     ...valueToExport
@@ -191,7 +219,10 @@ function getDefaultMDXOptions({
         plugins.remarkStructure,
         remarkStructureOptions
       ],
-      [remarkMdxExport, { values: mdxExports }]
+      [
+        remarkPostprocess,
+        { injectExports: mdxExports }
+      ]
     ],
     mdxOptions.remarkPlugins
   );
@@ -212,7 +243,8 @@ function getDefaultMDXOptions({
 }
 
 // src/mdx-plugins/remark-include.ts
-var import_unist_util_visit = require("unist-util-visit");
+var import_unified = require("unified");
+var import_unist_util_visit2 = require("unist-util-visit");
 var path = __toESM(require("path"), 1);
 var fs = __toESM(require("fs/promises"), 1);
 
@@ -233,9 +265,13 @@ function fumaMatter(input) {
 }
 
 // src/mdx-plugins/remark-include.ts
-function flattenNode(node) {
+var import_remark_parse = __toESM(require("remark-parse"), 1);
+var import_remark_mdx = __toESM(require("remark-mdx"), 1);
+var import_mdx_plugins = require("fumadocs-core/mdx-plugins");
+var baseProcessor = (0, import_unified.unified)().use(import_mdx_plugins.remarkHeading);
+function flattenNode2(node) {
   if ("children" in node)
-    return node.children.map((child) => flattenNode(child)).join("");
+    return node.children.map((child) => flattenNode2(child)).join("");
   if ("value" in node) return node.value;
   return "";
 }
@@ -248,86 +284,96 @@ function parseSpecifier(specifier) {
   };
 }
 function extractSection(root, section) {
+  let nodes;
   for (const node of root.children) {
     if (node.type === "mdxJsxFlowElement" && node.name === "section" && node.attributes.some(
       (attr) => attr.type === "mdxJsxAttribute" && attr.name === "id" && attr.value === section
     )) {
-      return {
-        type: "root",
-        children: node.children
-      };
+      nodes = node.children;
+      break;
+    }
+    if (node.type === "heading" && node.data?.hProperties?.id === section) {
+      nodes = [node];
+      continue;
     }
+    if (!nodes) continue;
+    if (node.type === "heading") break;
+    nodes.push(node);
   }
+  if (nodes)
+    return {
+      type: "root",
+      children: nodes
+    };
 }
 function remarkInclude() {
   const TagName = "include";
+  async function embedContent(file, heading, params, data) {
+    let content;
+    try {
+      content = (await fs.readFile(file)).toString();
+    } catch (e) {
+      throw new Error(
+        `failed to read file ${file}
+${e instanceof Error ? e.message : String(e)}`,
+        { cause: e }
+      );
+    }
+    const ext = path.extname(file);
+    data._compiler?.addDependency(file);
+    if (params.lang || ext !== ".md" && ext !== ".mdx") {
+      const lang = params.lang ?? ext.slice(1);
+      return {
+        type: "code",
+        lang,
+        meta: params.meta,
+        value: content,
+        data: {}
+      };
+    }
+    const processor = (data._getProcessor ?? getDefaultProcessor)(
+      ext === ".mdx" ? "mdx" : "md"
+    );
+    let parsed = await baseProcessor.run(
+      processor.parse(fumaMatter(content).content)
+    );
+    if (heading) {
+      const extracted = extractSection(parsed, heading);
+      if (!extracted)
+        throw new Error(
+          `Cannot find section ${heading} in ${file}, make sure you have encapsulated the section in a <section id="${heading}"> tag.`
+        );
+      parsed = extracted;
+    }
+    await update(parsed, path.dirname(file), data);
+    return parsed;
+  }
   async function update(tree, directory, data) {
     const queue = [];
-    (0, import_unist_util_visit.visit)(
+    (0, import_unist_util_visit2.visit)(
       tree,
       ["mdxJsxFlowElement", "mdxJsxTextElement"],
-      (node, _, parent) => {
-        let specifier;
+      (_node, _, parent) => {
+        const node = _node;
+        if (node.name !== TagName) return;
         const params = {};
-        if ((node.type === "mdxJsxFlowElement" || node.type === "mdxJsxTextElement") && node.name === TagName) {
-          const value = flattenNode(node);
-          if (value.length > 0) {
-            for (const attr of node.attributes) {
-              if (attr.type === "mdxJsxAttribute" && (typeof attr.value === "string" || attr.value === null)) {
-                params[attr.name] = attr.value;
-              }
-            }
-            specifier = value;
+        const specifier = flattenNode2(node);
+        if (specifier.length === 0) return "skip";
+        for (const attr of node.attributes) {
+          if (attr.type === "mdxJsxAttribute" && (typeof attr.value === "string" || attr.value === null)) {
+            params[attr.name] = attr.value;
           }
         }
-        if (!specifier) return;
-        const { file, section } = parseSpecifier(specifier);
-        const targetPath = path.resolve(
+        const { file: relativePath, section } = parseSpecifier(specifier);
+        const file = path.resolve(
           "cwd" in params ? process.cwd() : directory,
-          file
+          relativePath
         );
-        const asCode = params.lang || !file.endsWith(".md") && !file.endsWith(".mdx");
         queue.push(
-          fs.readFile(targetPath).then((buffer) => buffer.toString()).then(async (content) => {
-            data._compiler?.addDependency(targetPath);
-            if (asCode) {
-              const lang = params.lang ?? path.extname(file).slice(1);
-              Object.assign(node, {
-                type: "code",
-                lang,
-                meta: params.meta,
-                value: content,
-                data: {}
-              });
-              return;
-            }
-            const processor = data._processor ? data._processor.getProcessor(
-              targetPath.endsWith(".md") ? "md" : "mdx"
-            ) : this;
-            let parsed = processor.parse(fumaMatter(content).content);
-            if (section) {
-              const extracted = extractSection(parsed, section);
-              if (!extracted)
-                throw new Error(
-                  `Cannot find section ${section} in ${file}, make sure you have encapsulated the section in a <section id="${section}"> tag`
-                );
-              parsed = extracted;
-            }
-            await update.call(
-              processor,
-              parsed,
-              path.dirname(targetPath),
-              data
-            );
+          embedContent(file, section, params, data).then((replace) => {
             Object.assign(
               parent && parent.type === "paragraph" ? parent : node,
-              parsed
-            );
-          }).catch((e) => {
-            throw new Error(
-              `failed to read file ${targetPath}
-${e instanceof Error ? e.message : String(e)}`,
-              { cause: e }
+              replace
             );
           })
         );
@@ -337,9 +383,14 @@ ${e instanceof Error ? e.message : String(e)}`,
     await Promise.all(queue);
   }
   return async (tree, file) => {
-    await update.call(this, tree, path.dirname(file.path), file.data);
+    await update(tree, path.dirname(file.path), file.data);
   };
 }
+function getDefaultProcessor(format) {
+  const mdProcessor = (0, import_unified.unified)().use(import_remark_parse.default);
+  if (format === "md") return mdProcessor;
+  return mdProcessor.use(import_remark_mdx.default);
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   defineCollections,

package/dist/config/index.d.cts

@@ -6,6 +6,10 @@ import 'fumadocs-core/mdx-plugins';
 import '@mdx-js/mdx';
 import 'zod';
 
+interface Params {
+    lang?: string;
+    meta?: string;
+}
 declare function remarkInclude(this: Processor): Transformer<Root, Root>;
 
-export { remarkInclude };
+export { type Params, remarkInclude };

package/dist/config/index.d.ts

@@ -6,6 +6,10 @@ import 'fumadocs-core/mdx-plugins';
 import '@mdx-js/mdx';
 import 'zod';
 
+interface Params {
+    lang?: string;
+    meta?: string;
+}
 declare function remarkInclude(this: Processor): Transformer<Root, Root>;
 
-export { remarkInclude };
+export { type Params, remarkInclude };

package/dist/config/index.js

@@ -7,10 +7,10 @@ import {
 } from "../chunk-GBMFGEC7.js";
 import {
   getDefaultMDXOptions
-} from "../chunk-GYWPPGFD.js";
+} from "../chunk-SMSNZ6N5.js";
 import {
   remarkInclude
-} from "../chunk-IGXZS2W6.js";
+} from "../chunk-SVTXMVLQ.js";
 import "../chunk-VWJKRQZR.js";
 export {
   defineCollections,