@docusaurus/mdx-loader 0.0.0-4944 → 0.0.0-4945

package/lib/index.d.ts

@@ -4,27 +4,30 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { MDXOptions } from '@docusaurus/mdx-loader';
-import type { LoaderContext } from 'webpack';
-declare type Options = MDXOptions & {
-    staticDirs: string[];
-    siteDir: string;
-    isMDXPartial?: (filePath: string) => boolean;
-    isMDXPartialFrontMatterWarningDisabled?: boolean;
-    removeContentTitle?: boolean;
-    metadataPath?: string | ((filePath: string) => string);
-    createAssets?: (metadata: {
-        frontMatter: {
-            [key: string]: unknown;
-        };
-        metadata: {
-            [key: string]: unknown;
-        };
-    }) => {
-        [key: string]: unknown;
-    };
-    filepath: string;
+/// <reference types="react" />
+import { mdxLoader } from './loader';
+export default mdxLoader;
+export declare type TOCItem = {
+    readonly value: string;
+    readonly id: string;
+    readonly level: number;
 };
-export default function mdxLoader(this: LoaderContext<Options>, fileString: string): Promise<void>;
-export {};
+export declare type LoadedMDXContent<FrontMatter, Metadata, Assets = undefined> = {
+    /** As verbatim declared in the MDX document. */
+    readonly frontMatter: FrontMatter;
+    /** As provided by the content plugin. */
+    readonly metadata: Metadata;
+    /** A list of TOC items (headings). */
+    readonly toc: readonly TOCItem[];
+    /** First h1 title before any content. */
+    readonly contentTitle: string | undefined;
+    /**
+     * Usually image assets that may be collocated like `./img/thumbnail.png`.
+     * The loader would also bundle these assets and the client should use these
+     * in priority.
+     */
+    readonly assets: Assets;
+    (): JSX.Element;
+};
+export type { Options, MDXPlugin, MDXOptions } from './loader';
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAkBH,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,wBAAwB,CAAC;AACvD,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,SAAS,CAAC;AAsB3C,aAAK,OAAO,GAAG,UAAU,GAAG;IAC1B,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC;IAC7C,sCAAsC,CAAC,EAAE,OAAO,CAAC;IACjD,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,YAAY,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAC,CAAC;IACvD,YAAY,CAAC,EAAE,CAAC,QAAQ,EAAE;QACxB,WAAW,EAAE;YAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAC,CAAC;QACtC,QAAQ,EAAE;YAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAC,CAAC;KACpC,KAAK;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,CAAC;IAC/B,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AA6DF,wBAA8B,SAAS,CACrC,IAAI,EAAE,aAAa,CAAC,OAAO,CAAC,EAC5B,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC,CAyHf"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;;AAEH,OAAO,EAAC,SAAS,EAAC,MAAM,UAAU,CAAC;AAEnC,eAAe,SAAS,CAAC;AAEzB,oBAAY,OAAO,GAAG;IACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,oBAAY,gBAAgB,CAAC,WAAW,EAAE,QAAQ,EAAE,MAAM,GAAG,SAAS,IAAI;IACxE,gDAAgD;IAChD,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAClC,yCAAyC;IACzC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,sCAAsC;IACtC,QAAQ,CAAC,GAAG,EAAE,SAAS,OAAO,EAAE,CAAC;IACjC,yCAAyC;IACzC,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1C;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,IAAI,GAAG,CAAC,OAAO,CAAC;CACjB,CAAC;AACF,YAAY,EAAC,OAAO,EAAE,SAAS,EAAE,UAAU,EAAC,MAAM,UAAU,CAAC"}

package/lib/index.js

@@ -6,188 +6,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
-const mdx_1 = require("@mdx-js/mdx");
-const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
-const remark_emoji_1 = tslib_1.__importDefault(require("remark-emoji"));
-const utils_1 = require("@docusaurus/utils");
-const stringify_object_1 = tslib_1.__importDefault(require("stringify-object"));
-const headings_1 = tslib_1.__importDefault(require("./remark/headings"));
-const toc_1 = tslib_1.__importDefault(require("./remark/toc"));
-const unwrapMdxCodeBlocks_1 = tslib_1.__importDefault(require("./remark/unwrapMdxCodeBlocks"));
-const transformImage_1 = tslib_1.__importDefault(require("./remark/transformImage"));
-const transformLinks_1 = tslib_1.__importDefault(require("./remark/transformLinks"));
-const { loaders: { inlineMarkdownImageFileLoader }, } = (0, utils_1.getFileLoaderUtils)();
-const pragma = `
-/* @jsxRuntime classic */
-/* @jsx mdx */
-/* @jsxFrag mdx.Fragment */
-`;
-const DEFAULT_OPTIONS = {
-    rehypePlugins: [],
-    remarkPlugins: [unwrapMdxCodeBlocks_1.default, remark_emoji_1.default, headings_1.default, toc_1.default],
-    beforeDefaultRemarkPlugins: [],
-    beforeDefaultRehypePlugins: [],
-};
-const compilerCache = new Map();
-/**
- * When this throws, it generally means that there's no metadata file associated
- * with this MDX document. It can happen when using MDX partials (usually
- * starting with _). That's why it's important to provide the `isMDXPartial`
- * function in config
- */
-async function readMetadataPath(metadataPath) {
-    try {
-        return await fs_extra_1.default.readFile(metadataPath, 'utf8');
-    }
-    catch (err) {
-        logger_1.default.error `MDX loader can't read MDX metadata file path=${metadataPath}. Maybe the isMDXPartial option function was not provided?`;
-        throw err;
-    }
-}
-/**
- * Converts assets an object with Webpack require calls code.
- * This is useful for mdx files to reference co-located assets using relative
- * paths. Those assets should enter the Webpack assets pipeline and be hashed.
- * For now, we only handle that for images and paths starting with `./`:
- *
- * `{image: "./myImage.png"}` => `{image: require("./myImage.png")}`
- */
-function createAssetsExportCode(assets) {
-    if (Object.keys(assets).length === 0) {
-        return 'undefined';
-    }
-    // TODO implementation can be completed/enhanced
-    function createAssetValueCode(assetValue) {
-        if (Array.isArray(assetValue)) {
-            const arrayItemCodes = assetValue.map((item) => createAssetValueCode(item) ?? 'undefined');
-            return `[${arrayItemCodes.join(', ')}]`;
-        }
-        // Only process string values starting with ./
-        // We could enhance this logic and check if file exists on disc?
-        if (typeof assetValue === 'string' && assetValue.startsWith('./')) {
-            // TODO do we have other use-cases than image assets?
-            // Probably not worth adding more support, as we want to move to Webpack 5 new asset system (https://github.com/facebook/docusaurus/pull/4708)
-            const inlineLoader = inlineMarkdownImageFileLoader;
-            return `require("${inlineLoader}${(0, utils_1.escapePath)(assetValue)}").default`;
-        }
-        return undefined;
-    }
-    const assetEntries = Object.entries(assets);
-    const codeLines = assetEntries
-        .map(([key, value]) => {
-        const assetRequireCode = createAssetValueCode(value);
-        return assetRequireCode ? `"${key}": ${assetRequireCode},` : undefined;
-    })
-        .filter(Boolean);
-    return `{\n${codeLines.join('\n')}\n}`;
-}
-async function mdxLoader(fileString) {
-    const callback = this.async();
-    const filePath = this.resourcePath;
-    const reqOptions = this.getOptions() ?? {};
-    const { frontMatter, content: contentWithTitle } = (0, utils_1.parseFrontMatter)(fileString);
-    const { content, contentTitle } = (0, utils_1.parseMarkdownContentTitle)(contentWithTitle, {
-        removeContentTitle: reqOptions.removeContentTitle,
-    });
-    const hasFrontMatter = Object.keys(frontMatter).length > 0;
-    if (!compilerCache.has(this.query)) {
-        const options = {
-            ...reqOptions,
-            remarkPlugins: [
-                ...(reqOptions.beforeDefaultRemarkPlugins ?? []),
-                ...DEFAULT_OPTIONS.remarkPlugins,
-                [
-                    transformImage_1.default,
-                    {
-                        staticDirs: reqOptions.staticDirs,
-                        siteDir: reqOptions.siteDir,
-                    },
-                ],
-                [
-                    transformLinks_1.default,
-                    {
-                        staticDirs: reqOptions.staticDirs,
-                        siteDir: reqOptions.siteDir,
-                    },
-                ],
-                ...(reqOptions.remarkPlugins ?? []),
-            ],
-            rehypePlugins: [
-                ...(reqOptions.beforeDefaultRehypePlugins ?? []),
-                ...DEFAULT_OPTIONS.rehypePlugins,
-                ...(reqOptions.rehypePlugins ?? []),
-            ],
-        };
-        compilerCache.set(this.query, [(0, mdx_1.createCompiler)(options), options]);
-    }
-    const [compiler, options] = compilerCache.get(this.query);
-    let result;
-    try {
-        result = await compiler
-            .process({
-            contents: content,
-            path: this.resourcePath,
-        })
-            .then((res) => res.toString());
-    }
-    catch (err) {
-        return callback(err);
-    }
-    // MDX partials are MDX files starting with _ or in a folder starting with _
-    // Partial are not expected to have associated metadata files or front matter
-    const isMDXPartial = options.isMDXPartial?.(filePath);
-    if (isMDXPartial && hasFrontMatter) {
-        const errorMessage = `Docusaurus MDX partial files should not contain front matter.
-Those partial files use the _ prefix as a convention by default, but this is configurable.
-File at ${filePath} contains front matter that will be ignored:
-${JSON.stringify(frontMatter, null, 2)}`;
-        if (!options.isMDXPartialFrontMatterWarningDisabled) {
-            const shouldError = process.env.NODE_ENV === 'test' || process.env.CI;
-            if (shouldError) {
-                return callback(new Error(errorMessage));
-            }
-            logger_1.default.warn(errorMessage);
-        }
-    }
-    function getMetadataPath() {
-        if (!isMDXPartial) {
-            // Read metadata for this MDX and export it.
-            if (options.metadataPath && typeof options.metadataPath === 'function') {
-                return options.metadataPath(filePath);
-            }
-        }
-        return undefined;
-    }
-    const metadataPath = getMetadataPath();
-    if (metadataPath) {
-        this.addDependency(metadataPath);
-    }
-    const metadataJsonString = metadataPath
-        ? await readMetadataPath(metadataPath)
-        : undefined;
-    const metadata = metadataJsonString
-        ? JSON.parse(metadataJsonString)
-        : undefined;
-    const assets = reqOptions.createAssets && metadata
-        ? reqOptions.createAssets({ frontMatter, metadata })
-        : undefined;
-    const exportsCode = `
-export const frontMatter = ${(0, stringify_object_1.default)(frontMatter)};
-export const contentTitle = ${(0, stringify_object_1.default)(contentTitle)};
-${metadataJsonString ? `export const metadata = ${metadataJsonString};` : ''}
-${assets ? `export const assets = ${createAssetsExportCode(assets)};` : ''}
-`;
-    const code = `
-${pragma}
-import React from 'react';
-import { mdx } from '@mdx-js/react';
-
-${exportsCode}
-${result}
-`;
-    return callback(null, code);
-}
-exports.default = mdxLoader;
+const loader_1 = require("./loader");
+exports.default = loader_1.mdxLoader;
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,gEAA0B;AAC1B,qCAA2C;AAC3C,wEAAwC;AACxC,wEAAiC;AACjC,6CAK2B;AAC3B,gFAA+C;AAC/C,yEAAyC;AACzC,+DAA+B;AAC/B,+FAA+D;AAC/D,qFAAqD;AACrD,qFAAqD;AAKrD,MAAM,EACJ,OAAO,EAAE,EAAC,6BAA6B,EAAC,GACzC,GAAG,IAAA,0BAAkB,GAAE,CAAC;AAEzB,MAAM,MAAM,GAAG;;;;CAId,CAAC;AAEF,MAAM,eAAe,GAAe;IAClC,aAAa,EAAE,EAAE;IACjB,aAAa,EAAE,CAAC,6BAAmB,EAAE,sBAAK,EAAE,kBAAQ,EAAE,aAAG,CAAC;IAC1D,0BAA0B,EAAE,EAAE;IAC9B,0BAA0B,EAAE,EAAE;CAC/B,CAAC;AAEF,MAAM,aAAa,GAAG,IAAI,GAAG,EAA0C,CAAC;AAgBxE;;;;;GAKG;AACH,KAAK,UAAU,gBAAgB,CAAC,YAAoB;IAClD,IAAI;QACF,OAAO,MAAM,kBAAE,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;KAChD;IAAC,OAAO,GAAG,EAAE;QACZ,gBAAM,CAAC,KAAK,CAAA,gDAAgD,YAAY,4DAA4D,CAAC;QACrI,MAAM,GAAG,CAAC;KACX;AACH,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,sBAAsB,CAAC,MAAgC;IAC9D,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;QACpC,OAAO,WAAW,CAAC;KACpB;IAED,gDAAgD;IAChD,SAAS,oBAAoB,CAAC,UAAmB;QAC/C,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YAC7B,MAAM,cAAc,GAAG,UAAU,CAAC,GAAG,CACnC,CAAC,IAAI,EAAE,EAAE,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,WAAW,CACpD,CAAC;YACF,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;SACzC;QACD,8CAA8C;QAC9C,gEAAgE;QAChE,IAAI,OAAO,UAAU,KAAK,QAAQ,IAAI,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;YACjE,qDAAqD;YACrD,8IAA8I;YAC9I,MAAM,YAAY,GAAG,6BAA6B,CAAC;YACnD,OAAO,YAAY,YAAY,GAAG,IAAA,kBAAU,EAAC,UAAU,CAAC,YAAY,CAAC;SACtE;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAE5C,MAAM,SAAS,GAAG,YAAY;SAC3B,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACpB,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;QACrD,OAAO,gBAAgB,CAAC,CAAC,CAAC,IAAI,GAAG,MAAM,gBAAgB,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;IACzE,CAAC,CAAC;SACD,MAAM,CAAC,OAAO,CAAC,CAAC;IAEnB,OAAO,MAAM,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;AACzC,CAAC;AAEc,KAAK,UAAU,SAAS,CAErC,UAAkB;IAElB,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;IAC9B,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC;IACnC,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC;IAE3C,MAAM,EAAC,WAAW,EAAE,OAAO,EAAE,gBAAgB,EAAC,GAAG,IAAA,wBAAgB,EAAC,UAAU,CAAC,CAAC;IAE9E,MAAM,EAAC,OAAO,EAAE,YAAY,EAAC,GAAG,IAAA,iCAAyB,EAAC,gBAAgB,EAAE;QAC1E,kBAAkB,EAAE,UAAU,CAAC,kBAAkB;KAClD,CAAC,CAAC;IAEH,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IAE3D,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;QAClC,MAAM,OAAO,GAAY;YACvB,GAAG,UAAU;YACb,aAAa,EAAE;gBACb,GAAG,CAAC,UAAU,CAAC,0BAA0B,IAAI,EAAE,CAAC;gBAChD,GAAG,eAAe,CAAC,aAAa;gBAChC;oBACE,wBAAc;oBACd;wBACE,UAAU,EAAE,UAAU,CAAC,UAAU;wBACjC,OAAO,EAAE,UAAU,CAAC,OAAO;qBAC5B;iBACF;gBACD;oBACE,wBAAc;oBACd;wBACE,UAAU,EAAE,UAAU,CAAC,UAAU;wBACjC,OAAO,EAAE,UAAU,CAAC,OAAO;qBAC5B;iBACF;gBACD,GAAG,CAAC,UAAU,CAAC,aAAa,IAAI,EAAE,CAAC;aACpC;YACD,aAAa,EAAE;gBACb,GAAG,CAAC,UAAU,CAAC,0BAA0B,IAAI,EAAE,CAAC;gBAChD,GAAG,eAAe,CAAC,aAAa;gBAChC,GAAG,CAAC,UAAU,CAAC,aAAa,IAAI,EAAE,CAAC;aACpC;SACF,CAAC;QACF,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,IAAA,oBAAc,EAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;KACnE;IAED,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAE,CAAC;IAE3D,IAAI,MAAc,CAAC;IACnB,IAAI;QACF,MAAM,GAAG,MAAM,QAAQ;aACpB,OAAO,CAAC;YACP,QAAQ,EAAE,OAAO;YACjB,IAAI,EAAE,IAAI,CAAC,YAAY;SACxB,CAAC;aACD,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;KAClC;IAAC,OAAO,GAAG,EAAE;QACZ,OAAO,QAAQ,CAAC,GAAY,CAAC,CAAC;KAC/B;IAED,4EAA4E;IAC5E,6EAA6E;IAC7E,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,QAAQ,CAAC,CAAC;IACtD,IAAI,YAAY,IAAI,cAAc,EAAE;QAClC,MAAM,YAAY,GAAG;;UAEf,QAAQ;EAChB,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;QAErC,IAAI,CAAC,OAAO,CAAC,sCAAsC,EAAE;YACnD,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACtE,IAAI,WAAW,EAAE;gBACf,OAAO,QAAQ,CAAC,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;aAC1C;YACD,gBAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;SAC3B;KACF;IAED,SAAS,eAAe;QACtB,IAAI,CAAC,YAAY,EAAE;YACjB,4CAA4C;YAC5C,IAAI,OAAO,CAAC,YAAY,IAAI,OAAO,OAAO,CAAC,YAAY,KAAK,UAAU,EAAE;gBACtE,OAAO,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;aACvC;SACF;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,YAAY,GAAG,eAAe,EAAE,CAAC;IACvC,IAAI,YAAY,EAAE;QAChB,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;KAClC;IAED,MAAM,kBAAkB,GAAG,YAAY;QACrC,CAAC,CAAC,MAAM,gBAAgB,CAAC,YAAY,CAAC;QACtC,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,QAAQ,GAAG,kBAAkB;QACjC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC;QAChC,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,MAAM,GACV,UAAU,CAAC,YAAY,IAAI,QAAQ;QACjC,CAAC,CAAC,UAAU,CAAC,YAAY,CAAC,EAAC,WAAW,EAAE,QAAQ,EAAC,CAAC;QAClD,CAAC,CAAC,SAAS,CAAC;IAEhB,MAAM,WAAW,GAAG;6BACO,IAAA,0BAAe,EAAC,WAAW,CAAC;8BAC3B,IAAA,0BAAe,EAAC,YAAY,CAAC;EACzD,kBAAkB,CAAC,CAAC,CAAC,2BAA2B,kBAAkB,GAAG,CAAC,CAAC,CAAC,EAAE;EAC1E,MAAM,CAAC,CAAC,CAAC,yBAAyB,sBAAsB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;CACzE,CAAC;IAEA,MAAM,IAAI,GAAG;EACb,MAAM;;;;EAIN,WAAW;EACX,MAAM;CACP,CAAC;IAEA,OAAO,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AAC9B,CAAC;AA5HD,4BA4HC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAEH,qCAAmC;AAEnC,kBAAe,kBAAS,CAAC"}

package/lib/loader.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import type { LoaderContext } from 'webpack';
+import type { Plugin } from 'unified';
+export declare type MDXPlugin = [
+    Plugin<any[]>,
+    any
+] | Plugin<any[]>;
+export declare type MDXOptions = {
+    remarkPlugins: MDXPlugin[];
+    rehypePlugins: MDXPlugin[];
+    beforeDefaultRemarkPlugins: MDXPlugin[];
+    beforeDefaultRehypePlugins: MDXPlugin[];
+};
+export declare type Options = MDXOptions & {
+    staticDirs: string[];
+    siteDir: string;
+    isMDXPartial?: (filePath: string) => boolean;
+    isMDXPartialFrontMatterWarningDisabled?: boolean;
+    removeContentTitle?: boolean;
+    metadataPath?: string | ((filePath: string) => string);
+    createAssets?: (metadata: {
+        frontMatter: {
+            [key: string]: unknown;
+        };
+        metadata: {
+            [key: string]: unknown;
+        };
+    }) => {
+        [key: string]: unknown;
+    };
+    filepath: string;
+};
+export declare function mdxLoader(this: LoaderContext<Options>, fileString: string): Promise<void>;
+//# sourceMappingURL=loader.d.ts.map

package/lib/loader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loader.d.ts","sourceRoot":"","sources":["../src/loader.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAkBH,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,SAAS,CAAC;AAC3C,OAAO,KAAK,EAAY,MAAM,EAAC,MAAM,SAAS,CAAC;AAqB/C,oBAAY,SAAS,GAEnB;IAAC,MAAM,CAAC,GAAG,EAAE,CAAC;IAAE,GAAG;CAAC,GAAG,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC;AACvC,oBAAY,UAAU,GAAG;IACvB,aAAa,EAAE,SAAS,EAAE,CAAC;IAC3B,aAAa,EAAE,SAAS,EAAE,CAAC;IAC3B,0BAA0B,EAAE,SAAS,EAAE,CAAC;IACxC,0BAA0B,EAAE,SAAS,EAAE,CAAC;CACzC,CAAC;AAEF,oBAAY,OAAO,GAAG,UAAU,GAAG;IACjC,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC;IAC7C,sCAAsC,CAAC,EAAE,OAAO,CAAC;IACjD,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,YAAY,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAC,CAAC;IACvD,YAAY,CAAC,EAAE,CAAC,QAAQ,EAAE;QACxB,WAAW,EAAE;YAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAC,CAAC;QACtC,QAAQ,EAAE;YAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAC,CAAC;KACpC,KAAK;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,CAAC;IAC/B,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AA6DF,wBAAsB,SAAS,CAC7B,IAAI,EAAE,aAAa,CAAC,OAAO,CAAC,EAC5B,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC,CAyHf"}

package/lib/loader.js

@@ -0,0 +1,194 @@
+"use strict";
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mdxLoader = void 0;
+const tslib_1 = require("tslib");
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const mdx_1 = require("@mdx-js/mdx");
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
+const remark_emoji_1 = tslib_1.__importDefault(require("remark-emoji"));
+const utils_1 = require("@docusaurus/utils");
+const stringify_object_1 = tslib_1.__importDefault(require("stringify-object"));
+const headings_1 = tslib_1.__importDefault(require("./remark/headings"));
+const toc_1 = tslib_1.__importDefault(require("./remark/toc"));
+const unwrapMdxCodeBlocks_1 = tslib_1.__importDefault(require("./remark/unwrapMdxCodeBlocks"));
+const transformImage_1 = tslib_1.__importDefault(require("./remark/transformImage"));
+const transformLinks_1 = tslib_1.__importDefault(require("./remark/transformLinks"));
+const { loaders: { inlineMarkdownImageFileLoader }, } = (0, utils_1.getFileLoaderUtils)();
+const pragma = `
+/* @jsxRuntime classic */
+/* @jsx mdx */
+/* @jsxFrag mdx.Fragment */
+`;
+const DEFAULT_OPTIONS = {
+    rehypePlugins: [],
+    remarkPlugins: [unwrapMdxCodeBlocks_1.default, remark_emoji_1.default, headings_1.default, toc_1.default],
+    beforeDefaultRemarkPlugins: [],
+    beforeDefaultRehypePlugins: [],
+};
+const compilerCache = new Map();
+/**
+ * When this throws, it generally means that there's no metadata file associated
+ * with this MDX document. It can happen when using MDX partials (usually
+ * starting with _). That's why it's important to provide the `isMDXPartial`
+ * function in config
+ */
+async function readMetadataPath(metadataPath) {
+    try {
+        return await fs_extra_1.default.readFile(metadataPath, 'utf8');
+    }
+    catch (err) {
+        logger_1.default.error `MDX loader can't read MDX metadata file path=${metadataPath}. Maybe the isMDXPartial option function was not provided?`;
+        throw err;
+    }
+}
+/**
+ * Converts assets an object with Webpack require calls code.
+ * This is useful for mdx files to reference co-located assets using relative
+ * paths. Those assets should enter the Webpack assets pipeline and be hashed.
+ * For now, we only handle that for images and paths starting with `./`:
+ *
+ * `{image: "./myImage.png"}` => `{image: require("./myImage.png")}`
+ */
+function createAssetsExportCode(assets) {
+    if (Object.keys(assets).length === 0) {
+        return 'undefined';
+    }
+    // TODO implementation can be completed/enhanced
+    function createAssetValueCode(assetValue) {
+        if (Array.isArray(assetValue)) {
+            const arrayItemCodes = assetValue.map((item) => createAssetValueCode(item) ?? 'undefined');
+            return `[${arrayItemCodes.join(', ')}]`;
+        }
+        // Only process string values starting with ./
+        // We could enhance this logic and check if file exists on disc?
+        if (typeof assetValue === 'string' && assetValue.startsWith('./')) {
+            // TODO do we have other use-cases than image assets?
+            // Probably not worth adding more support, as we want to move to Webpack 5 new asset system (https://github.com/facebook/docusaurus/pull/4708)
+            const inlineLoader = inlineMarkdownImageFileLoader;
+            return `require("${inlineLoader}${(0, utils_1.escapePath)(assetValue)}").default`;
+        }
+        return undefined;
+    }
+    const assetEntries = Object.entries(assets);
+    const codeLines = assetEntries
+        .map(([key, value]) => {
+        const assetRequireCode = createAssetValueCode(value);
+        return assetRequireCode ? `"${key}": ${assetRequireCode},` : undefined;
+    })
+        .filter(Boolean);
+    return `{\n${codeLines.join('\n')}\n}`;
+}
+async function mdxLoader(fileString) {
+    const callback = this.async();
+    const filePath = this.resourcePath;
+    const reqOptions = this.getOptions() ?? {};
+    const { frontMatter, content: contentWithTitle } = (0, utils_1.parseFrontMatter)(fileString);
+    const { content, contentTitle } = (0, utils_1.parseMarkdownContentTitle)(contentWithTitle, {
+        removeContentTitle: reqOptions.removeContentTitle,
+    });
+    const hasFrontMatter = Object.keys(frontMatter).length > 0;
+    if (!compilerCache.has(this.query)) {
+        const options = {
+            ...reqOptions,
+            remarkPlugins: [
+                ...(reqOptions.beforeDefaultRemarkPlugins ?? []),
+                ...DEFAULT_OPTIONS.remarkPlugins,
+                [
+                    transformImage_1.default,
+                    {
+                        staticDirs: reqOptions.staticDirs,
+                        siteDir: reqOptions.siteDir,
+                    },
+                ],
+                [
+                    transformLinks_1.default,
+                    {
+                        staticDirs: reqOptions.staticDirs,
+                        siteDir: reqOptions.siteDir,
+                    },
+                ],
+                ...(reqOptions.remarkPlugins ?? []),
+            ],
+            rehypePlugins: [
+                ...(reqOptions.beforeDefaultRehypePlugins ?? []),
+                ...DEFAULT_OPTIONS.rehypePlugins,
+                ...(reqOptions.rehypePlugins ?? []),
+            ],
+        };
+        compilerCache.set(this.query, [(0, mdx_1.createCompiler)(options), options]);
+    }
+    const [compiler, options] = compilerCache.get(this.query);
+    let result;
+    try {
+        result = await compiler
+            .process({
+            contents: content,
+            path: this.resourcePath,
+        })
+            .then((res) => res.toString());
+    }
+    catch (err) {
+        return callback(err);
+    }
+    // MDX partials are MDX files starting with _ or in a folder starting with _
+    // Partial are not expected to have associated metadata files or front matter
+    const isMDXPartial = options.isMDXPartial?.(filePath);
+    if (isMDXPartial && hasFrontMatter) {
+        const errorMessage = `Docusaurus MDX partial files should not contain front matter.
+Those partial files use the _ prefix as a convention by default, but this is configurable.
+File at ${filePath} contains front matter that will be ignored:
+${JSON.stringify(frontMatter, null, 2)}`;
+        if (!options.isMDXPartialFrontMatterWarningDisabled) {
+            const shouldError = process.env.NODE_ENV === 'test' || process.env.CI;
+            if (shouldError) {
+                return callback(new Error(errorMessage));
+            }
+            logger_1.default.warn(errorMessage);
+        }
+    }
+    function getMetadataPath() {
+        if (!isMDXPartial) {
+            // Read metadata for this MDX and export it.
+            if (options.metadataPath && typeof options.metadataPath === 'function') {
+                return options.metadataPath(filePath);
+            }
+        }
+        return undefined;
+    }
+    const metadataPath = getMetadataPath();
+    if (metadataPath) {
+        this.addDependency(metadataPath);
+    }
+    const metadataJsonString = metadataPath
+        ? await readMetadataPath(metadataPath)
+        : undefined;
+    const metadata = metadataJsonString
+        ? JSON.parse(metadataJsonString)
+        : undefined;
+    const assets = reqOptions.createAssets && metadata
+        ? reqOptions.createAssets({ frontMatter, metadata })
+        : undefined;
+    const exportsCode = `
+export const frontMatter = ${(0, stringify_object_1.default)(frontMatter)};
+export const contentTitle = ${(0, stringify_object_1.default)(contentTitle)};
+${metadataJsonString ? `export const metadata = ${metadataJsonString};` : ''}
+${assets ? `export const assets = ${createAssetsExportCode(assets)};` : ''}
+`;
+    const code = `
+${pragma}
+import React from 'react';
+import { mdx } from '@mdx-js/react';
+
+${exportsCode}
+${result}
+`;
+    return callback(null, code);
+}
+exports.mdxLoader = mdxLoader;
+//# sourceMappingURL=loader.js.map

package/lib/loader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loader.js","sourceRoot":"","sources":["../src/loader.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,gEAA0B;AAC1B,qCAA2C;AAC3C,wEAAwC;AACxC,wEAAiC;AACjC,6CAK2B;AAC3B,gFAA+C;AAC/C,yEAAyC;AACzC,+DAA+B;AAC/B,+FAA+D;AAC/D,qFAAqD;AACrD,qFAAqD;AAIrD,MAAM,EACJ,OAAO,EAAE,EAAC,6BAA6B,EAAC,GACzC,GAAG,IAAA,0BAAkB,GAAE,CAAC;AAEzB,MAAM,MAAM,GAAG;;;;CAId,CAAC;AAEF,MAAM,eAAe,GAAe;IAClC,aAAa,EAAE,EAAE;IACjB,aAAa,EAAE,CAAC,6BAAmB,EAAE,sBAAK,EAAE,kBAAQ,EAAE,aAAG,CAAC;IAC1D,0BAA0B,EAAE,EAAE;IAC9B,0BAA0B,EAAE,EAAE;CAC/B,CAAC;AAEF,MAAM,aAAa,GAAG,IAAI,GAAG,EAA0C,CAAC;AA0BxE;;;;;GAKG;AACH,KAAK,UAAU,gBAAgB,CAAC,YAAoB;IAClD,IAAI;QACF,OAAO,MAAM,kBAAE,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;KAChD;IAAC,OAAO,GAAG,EAAE;QACZ,gBAAM,CAAC,KAAK,CAAA,gDAAgD,YAAY,4DAA4D,CAAC;QACrI,MAAM,GAAG,CAAC;KACX;AACH,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,sBAAsB,CAAC,MAAgC;IAC9D,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;QACpC,OAAO,WAAW,CAAC;KACpB;IAED,gDAAgD;IAChD,SAAS,oBAAoB,CAAC,UAAmB;QAC/C,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YAC7B,MAAM,cAAc,GAAG,UAAU,CAAC,GAAG,CACnC,CAAC,IAAI,EAAE,EAAE,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,WAAW,CACpD,CAAC;YACF,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;SACzC;QACD,8CAA8C;QAC9C,gEAAgE;QAChE,IAAI,OAAO,UAAU,KAAK,QAAQ,IAAI,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;YACjE,qDAAqD;YACrD,8IAA8I;YAC9I,MAAM,YAAY,GAAG,6BAA6B,CAAC;YACnD,OAAO,YAAY,YAAY,GAAG,IAAA,kBAAU,EAAC,UAAU,CAAC,YAAY,CAAC;SACtE;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAE5C,MAAM,SAAS,GAAG,YAAY;SAC3B,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACpB,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;QACrD,OAAO,gBAAgB,CAAC,CAAC,CAAC,IAAI,GAAG,MAAM,gBAAgB,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;IACzE,CAAC,CAAC;SACD,MAAM,CAAC,OAAO,CAAC,CAAC;IAEnB,OAAO,MAAM,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;AACzC,CAAC;AAEM,KAAK,UAAU,SAAS,CAE7B,UAAkB;IAElB,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;IAC9B,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC;IACnC,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC;IAE3C,MAAM,EAAC,WAAW,EAAE,OAAO,EAAE,gBAAgB,EAAC,GAAG,IAAA,wBAAgB,EAAC,UAAU,CAAC,CAAC;IAE9E,MAAM,EAAC,OAAO,EAAE,YAAY,EAAC,GAAG,IAAA,iCAAyB,EAAC,gBAAgB,EAAE;QAC1E,kBAAkB,EAAE,UAAU,CAAC,kBAAkB;KAClD,CAAC,CAAC;IAEH,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IAE3D,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;QAClC,MAAM,OAAO,GAAY;YACvB,GAAG,UAAU;YACb,aAAa,EAAE;gBACb,GAAG,CAAC,UAAU,CAAC,0BAA0B,IAAI,EAAE,CAAC;gBAChD,GAAG,eAAe,CAAC,aAAa;gBAChC;oBACE,wBAAc;oBACd;wBACE,UAAU,EAAE,UAAU,CAAC,UAAU;wBACjC,OAAO,EAAE,UAAU,CAAC,OAAO;qBAC5B;iBACF;gBACD;oBACE,wBAAc;oBACd;wBACE,UAAU,EAAE,UAAU,CAAC,UAAU;wBACjC,OAAO,EAAE,UAAU,CAAC,OAAO;qBAC5B;iBACF;gBACD,GAAG,CAAC,UAAU,CAAC,aAAa,IAAI,EAAE,CAAC;aACpC;YACD,aAAa,EAAE;gBACb,GAAG,CAAC,UAAU,CAAC,0BAA0B,IAAI,EAAE,CAAC;gBAChD,GAAG,eAAe,CAAC,aAAa;gBAChC,GAAG,CAAC,UAAU,CAAC,aAAa,IAAI,EAAE,CAAC;aACpC;SACF,CAAC;QACF,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,IAAA,oBAAc,EAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;KACnE;IAED,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAE,CAAC;IAE3D,IAAI,MAAc,CAAC;IACnB,IAAI;QACF,MAAM,GAAG,MAAM,QAAQ;aACpB,OAAO,CAAC;YACP,QAAQ,EAAE,OAAO;YACjB,IAAI,EAAE,IAAI,CAAC,YAAY;SACxB,CAAC;aACD,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;KAClC;IAAC,OAAO,GAAG,EAAE;QACZ,OAAO,QAAQ,CAAC,GAAY,CAAC,CAAC;KAC/B;IAED,4EAA4E;IAC5E,6EAA6E;IAC7E,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,QAAQ,CAAC,CAAC;IACtD,IAAI,YAAY,IAAI,cAAc,EAAE;QAClC,MAAM,YAAY,GAAG;;UAEf,QAAQ;EAChB,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;QAErC,IAAI,CAAC,OAAO,CAAC,sCAAsC,EAAE;YACnD,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACtE,IAAI,WAAW,EAAE;gBACf,OAAO,QAAQ,CAAC,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;aAC1C;YACD,gBAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;SAC3B;KACF;IAED,SAAS,eAAe;QACtB,IAAI,CAAC,YAAY,EAAE;YACjB,4CAA4C;YAC5C,IAAI,OAAO,CAAC,YAAY,IAAI,OAAO,OAAO,CAAC,YAAY,KAAK,UAAU,EAAE;gBACtE,OAAO,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;aACvC;SACF;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,YAAY,GAAG,eAAe,EAAE,CAAC;IACvC,IAAI,YAAY,EAAE;QAChB,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;KAClC;IAED,MAAM,kBAAkB,GAAG,YAAY;QACrC,CAAC,CAAC,MAAM,gBAAgB,CAAC,YAAY,CAAC;QACtC,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,QAAQ,GAAG,kBAAkB;QACjC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC;QAChC,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,MAAM,GACV,UAAU,CAAC,YAAY,IAAI,QAAQ;QACjC,CAAC,CAAC,UAAU,CAAC,YAAY,CAAC,EAAC,WAAW,EAAE,QAAQ,EAAC,CAAC;QAClD,CAAC,CAAC,SAAS,CAAC;IAEhB,MAAM,WAAW,GAAG;6BACO,IAAA,0BAAe,EAAC,WAAW,CAAC;8BAC3B,IAAA,0BAAe,EAAC,YAAY,CAAC;EACzD,kBAAkB,CAAC,CAAC,CAAC,2BAA2B,kBAAkB,GAAG,CAAC,CAAC,CAAC,EAAE;EAC1E,MAAM,CAAC,CAAC,CAAC,yBAAyB,sBAAsB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;CACzE,CAAC;IAEA,MAAM,IAAI,GAAG;EACb,MAAM;;;;EAIN,WAAW;EACX,MAAM;CACP,CAAC;IAEA,OAAO,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AAC9B,CAAC;AA5HD,8BA4HC"}

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@docusaurus/mdx-loader",
-  "version": "0.0.0-4944",
+  "version": "0.0.0-4945",
   "description": "Docusaurus Loader for MDX",
   "main": "lib/index.js",
-  "types": "src/mdx-loader.d.ts",
+  "types": "lib/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
@@ -20,8 +20,8 @@
   "dependencies": {
     "@babel/parser": "^7.17.10",
     "@babel/traverse": "^7.17.10",
-    "@docusaurus/logger": "0.0.0-4944",
-    "@docusaurus/utils": "0.0.0-4944",
+    "@docusaurus/logger": "0.0.0-4945",
+    "@docusaurus/utils": "0.0.0-4945",
     "@mdx-js/mdx": "^1.6.22",
     "escape-html": "^1.0.3",
     "file-loader": "^6.2.0",
@@ -36,7 +36,7 @@
     "webpack": "^5.72.0"
   },
   "devDependencies": {
-    "@docusaurus/types": "0.0.0-4944",
+    "@docusaurus/types": "0.0.0-4945",
     "@types/escape-html": "^1.0.2",
     "@types/mdast": "^3.0.10",
     "@types/stringify-object": "^3.3.1",
@@ -54,5 +54,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "040fca0321d0539c16b21edc191af3142642b8c0"
+  "gitHead": "a3b20e1bfad392b7f91afef66de502e41a3adcb4"
 }

package/src/deps.d.ts

@@ -7,10 +7,13 @@
 
 // TODO Types provided by MDX 2.0 https://github.com/mdx-js/mdx/blob/main/packages/mdx/types/index.d.ts
 declare module '@mdx-js/mdx' {
-  import type {Processor} from 'unified';
-  import type {MDXPlugin} from '@docusaurus/mdx-loader';
+  import type {Processor, Plugin} from 'unified';
 
-  export type Options = {
+  type MDXPlugin =
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    [Plugin<any[]>, any] | Plugin<any[]>;
+
+  type Options = {
     filepath?: string;
     skipExport?: boolean;
     wrapExport?: string;

package/src/index.ts

@@ -5,240 +5,31 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import fs from 'fs-extra';
-import {createCompiler} from '@mdx-js/mdx';
-import logger from '@docusaurus/logger';
-import emoji from 'remark-emoji';
-import {
-  parseFrontMatter,
-  parseMarkdownContentTitle,
-  escapePath,
-  getFileLoaderUtils,
-} from '@docusaurus/utils';
-import stringifyObject from 'stringify-object';
-import headings from './remark/headings';
-import toc from './remark/toc';
-import unwrapMdxCodeBlocks from './remark/unwrapMdxCodeBlocks';
-import transformImage from './remark/transformImage';
-import transformLinks from './remark/transformLinks';
-import type {MDXOptions} from '@docusaurus/mdx-loader';
-import type {LoaderContext} from 'webpack';
-import type {Processor} from 'unified';
+import {mdxLoader} from './loader';
 
-const {
-  loaders: {inlineMarkdownImageFileLoader},
-} = getFileLoaderUtils();
+export default mdxLoader;
 
-const pragma = `
-/* @jsxRuntime classic */
-/* @jsx mdx */
-/* @jsxFrag mdx.Fragment */
-`;
-
-const DEFAULT_OPTIONS: MDXOptions = {
-  rehypePlugins: [],
-  remarkPlugins: [unwrapMdxCodeBlocks, emoji, headings, toc],
-  beforeDefaultRemarkPlugins: [],
-  beforeDefaultRehypePlugins: [],
+export type TOCItem = {
+  readonly value: string;
+  readonly id: string;
+  readonly level: number;
 };
 
-const compilerCache = new Map<string | Options, [Processor, Options]>();
-
-type Options = MDXOptions & {
-  staticDirs: string[];
-  siteDir: string;
-  isMDXPartial?: (filePath: string) => boolean;
-  isMDXPartialFrontMatterWarningDisabled?: boolean;
-  removeContentTitle?: boolean;
-  metadataPath?: string | ((filePath: string) => string);
-  createAssets?: (metadata: {
-    frontMatter: {[key: string]: unknown};
-    metadata: {[key: string]: unknown};
-  }) => {[key: string]: unknown};
-  filepath: string;
+export type LoadedMDXContent<FrontMatter, Metadata, Assets = undefined> = {
+  /** As verbatim declared in the MDX document. */
+  readonly frontMatter: FrontMatter;
+  /** As provided by the content plugin. */
+  readonly metadata: Metadata;
+  /** A list of TOC items (headings). */
+  readonly toc: readonly TOCItem[];
+  /** First h1 title before any content. */
+  readonly contentTitle: string | undefined;
+  /**
+   * Usually image assets that may be collocated like `./img/thumbnail.png`.
+   * The loader would also bundle these assets and the client should use these
+   * in priority.
+   */
+  readonly assets: Assets;
+  (): JSX.Element;
 };
-
-/**
- * When this throws, it generally means that there's no metadata file associated
- * with this MDX document. It can happen when using MDX partials (usually
- * starting with _). That's why it's important to provide the `isMDXPartial`
- * function in config
- */
-async function readMetadataPath(metadataPath: string) {
-  try {
-    return await fs.readFile(metadataPath, 'utf8');
-  } catch (err) {
-    logger.error`MDX loader can't read MDX metadata file path=${metadataPath}. Maybe the isMDXPartial option function was not provided?`;
-    throw err;
-  }
-}
-
-/**
- * Converts assets an object with Webpack require calls code.
- * This is useful for mdx files to reference co-located assets using relative
- * paths. Those assets should enter the Webpack assets pipeline and be hashed.
- * For now, we only handle that for images and paths starting with `./`:
- *
- * `{image: "./myImage.png"}` => `{image: require("./myImage.png")}`
- */
-function createAssetsExportCode(assets: {[key: string]: unknown}) {
-  if (Object.keys(assets).length === 0) {
-    return 'undefined';
-  }
-
-  // TODO implementation can be completed/enhanced
-  function createAssetValueCode(assetValue: unknown): string | undefined {
-    if (Array.isArray(assetValue)) {
-      const arrayItemCodes = assetValue.map(
-        (item) => createAssetValueCode(item) ?? 'undefined',
-      );
-      return `[${arrayItemCodes.join(', ')}]`;
-    }
-    // Only process string values starting with ./
-    // We could enhance this logic and check if file exists on disc?
-    if (typeof assetValue === 'string' && assetValue.startsWith('./')) {
-      // TODO do we have other use-cases than image assets?
-      // Probably not worth adding more support, as we want to move to Webpack 5 new asset system (https://github.com/facebook/docusaurus/pull/4708)
-      const inlineLoader = inlineMarkdownImageFileLoader;
-      return `require("${inlineLoader}${escapePath(assetValue)}").default`;
-    }
-    return undefined;
-  }
-
-  const assetEntries = Object.entries(assets);
-
-  const codeLines = assetEntries
-    .map(([key, value]) => {
-      const assetRequireCode = createAssetValueCode(value);
-      return assetRequireCode ? `"${key}": ${assetRequireCode},` : undefined;
-    })
-    .filter(Boolean);
-
-  return `{\n${codeLines.join('\n')}\n}`;
-}
-
-export default async function mdxLoader(
-  this: LoaderContext<Options>,
-  fileString: string,
-): Promise<void> {
-  const callback = this.async();
-  const filePath = this.resourcePath;
-  const reqOptions = this.getOptions() ?? {};
-
-  const {frontMatter, content: contentWithTitle} = parseFrontMatter(fileString);
-
-  const {content, contentTitle} = parseMarkdownContentTitle(contentWithTitle, {
-    removeContentTitle: reqOptions.removeContentTitle,
-  });
-
-  const hasFrontMatter = Object.keys(frontMatter).length > 0;
-
-  if (!compilerCache.has(this.query)) {
-    const options: Options = {
-      ...reqOptions,
-      remarkPlugins: [
-        ...(reqOptions.beforeDefaultRemarkPlugins ?? []),
-        ...DEFAULT_OPTIONS.remarkPlugins,
-        [
-          transformImage,
-          {
-            staticDirs: reqOptions.staticDirs,
-            siteDir: reqOptions.siteDir,
-          },
-        ],
-        [
-          transformLinks,
-          {
-            staticDirs: reqOptions.staticDirs,
-            siteDir: reqOptions.siteDir,
-          },
-        ],
-        ...(reqOptions.remarkPlugins ?? []),
-      ],
-      rehypePlugins: [
-        ...(reqOptions.beforeDefaultRehypePlugins ?? []),
-        ...DEFAULT_OPTIONS.rehypePlugins,
-        ...(reqOptions.rehypePlugins ?? []),
-      ],
-    };
-    compilerCache.set(this.query, [createCompiler(options), options]);
-  }
-
-  const [compiler, options] = compilerCache.get(this.query)!;
-
-  let result: string;
-  try {
-    result = await compiler
-      .process({
-        contents: content,
-        path: this.resourcePath,
-      })
-      .then((res) => res.toString());
-  } catch (err) {
-    return callback(err as Error);
-  }
-
-  // MDX partials are MDX files starting with _ or in a folder starting with _
-  // Partial are not expected to have associated metadata files or front matter
-  const isMDXPartial = options.isMDXPartial?.(filePath);
-  if (isMDXPartial && hasFrontMatter) {
-    const errorMessage = `Docusaurus MDX partial files should not contain front matter.
-Those partial files use the _ prefix as a convention by default, but this is configurable.
-File at ${filePath} contains front matter that will be ignored:
-${JSON.stringify(frontMatter, null, 2)}`;
-
-    if (!options.isMDXPartialFrontMatterWarningDisabled) {
-      const shouldError = process.env.NODE_ENV === 'test' || process.env.CI;
-      if (shouldError) {
-        return callback(new Error(errorMessage));
-      }
-      logger.warn(errorMessage);
-    }
-  }
-
-  function getMetadataPath(): string | undefined {
-    if (!isMDXPartial) {
-      // Read metadata for this MDX and export it.
-      if (options.metadataPath && typeof options.metadataPath === 'function') {
-        return options.metadataPath(filePath);
-      }
-    }
-    return undefined;
-  }
-
-  const metadataPath = getMetadataPath();
-  if (metadataPath) {
-    this.addDependency(metadataPath);
-  }
-
-  const metadataJsonString = metadataPath
-    ? await readMetadataPath(metadataPath)
-    : undefined;
-
-  const metadata = metadataJsonString
-    ? JSON.parse(metadataJsonString)
-    : undefined;
-
-  const assets =
-    reqOptions.createAssets && metadata
-      ? reqOptions.createAssets({frontMatter, metadata})
-      : undefined;
-
-  const exportsCode = `
-export const frontMatter = ${stringifyObject(frontMatter)};
-export const contentTitle = ${stringifyObject(contentTitle)};
-${metadataJsonString ? `export const metadata = ${metadataJsonString};` : ''}
-${assets ? `export const assets = ${createAssetsExportCode(assets)};` : ''}
-`;
-
-  const code = `
-${pragma}
-import React from 'react';
-import { mdx } from '@mdx-js/react';
-
-${exportsCode}
-${result}
-`;
-
-  return callback(null, code);
-}
+export type {Options, MDXPlugin, MDXOptions} from './loader';

package/src/loader.ts

@@ -0,0 +1,253 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import fs from 'fs-extra';
+import {createCompiler} from '@mdx-js/mdx';
+import logger from '@docusaurus/logger';
+import emoji from 'remark-emoji';
+import {
+  parseFrontMatter,
+  parseMarkdownContentTitle,
+  escapePath,
+  getFileLoaderUtils,
+} from '@docusaurus/utils';
+import stringifyObject from 'stringify-object';
+import headings from './remark/headings';
+import toc from './remark/toc';
+import unwrapMdxCodeBlocks from './remark/unwrapMdxCodeBlocks';
+import transformImage from './remark/transformImage';
+import transformLinks from './remark/transformLinks';
+import type {LoaderContext} from 'webpack';
+import type {Processor, Plugin} from 'unified';
+
+const {
+  loaders: {inlineMarkdownImageFileLoader},
+} = getFileLoaderUtils();
+
+const pragma = `
+/* @jsxRuntime classic */
+/* @jsx mdx */
+/* @jsxFrag mdx.Fragment */
+`;
+
+const DEFAULT_OPTIONS: MDXOptions = {
+  rehypePlugins: [],
+  remarkPlugins: [unwrapMdxCodeBlocks, emoji, headings, toc],
+  beforeDefaultRemarkPlugins: [],
+  beforeDefaultRehypePlugins: [],
+};
+
+const compilerCache = new Map<string | Options, [Processor, Options]>();
+
+export type MDXPlugin =
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  [Plugin<any[]>, any] | Plugin<any[]>;
+export type MDXOptions = {
+  remarkPlugins: MDXPlugin[];
+  rehypePlugins: MDXPlugin[];
+  beforeDefaultRemarkPlugins: MDXPlugin[];
+  beforeDefaultRehypePlugins: MDXPlugin[];
+};
+
+export type Options = MDXOptions & {
+  staticDirs: string[];
+  siteDir: string;
+  isMDXPartial?: (filePath: string) => boolean;
+  isMDXPartialFrontMatterWarningDisabled?: boolean;
+  removeContentTitle?: boolean;
+  metadataPath?: string | ((filePath: string) => string);
+  createAssets?: (metadata: {
+    frontMatter: {[key: string]: unknown};
+    metadata: {[key: string]: unknown};
+  }) => {[key: string]: unknown};
+  filepath: string;
+};
+
+/**
+ * When this throws, it generally means that there's no metadata file associated
+ * with this MDX document. It can happen when using MDX partials (usually
+ * starting with _). That's why it's important to provide the `isMDXPartial`
+ * function in config
+ */
+async function readMetadataPath(metadataPath: string) {
+  try {
+    return await fs.readFile(metadataPath, 'utf8');
+  } catch (err) {
+    logger.error`MDX loader can't read MDX metadata file path=${metadataPath}. Maybe the isMDXPartial option function was not provided?`;
+    throw err;
+  }
+}
+
+/**
+ * Converts assets an object with Webpack require calls code.
+ * This is useful for mdx files to reference co-located assets using relative
+ * paths. Those assets should enter the Webpack assets pipeline and be hashed.
+ * For now, we only handle that for images and paths starting with `./`:
+ *
+ * `{image: "./myImage.png"}` => `{image: require("./myImage.png")}`
+ */
+function createAssetsExportCode(assets: {[key: string]: unknown}) {
+  if (Object.keys(assets).length === 0) {
+    return 'undefined';
+  }
+
+  // TODO implementation can be completed/enhanced
+  function createAssetValueCode(assetValue: unknown): string | undefined {
+    if (Array.isArray(assetValue)) {
+      const arrayItemCodes = assetValue.map(
+        (item) => createAssetValueCode(item) ?? 'undefined',
+      );
+      return `[${arrayItemCodes.join(', ')}]`;
+    }
+    // Only process string values starting with ./
+    // We could enhance this logic and check if file exists on disc?
+    if (typeof assetValue === 'string' && assetValue.startsWith('./')) {
+      // TODO do we have other use-cases than image assets?
+      // Probably not worth adding more support, as we want to move to Webpack 5 new asset system (https://github.com/facebook/docusaurus/pull/4708)
+      const inlineLoader = inlineMarkdownImageFileLoader;
+      return `require("${inlineLoader}${escapePath(assetValue)}").default`;
+    }
+    return undefined;
+  }
+
+  const assetEntries = Object.entries(assets);
+
+  const codeLines = assetEntries
+    .map(([key, value]) => {
+      const assetRequireCode = createAssetValueCode(value);
+      return assetRequireCode ? `"${key}": ${assetRequireCode},` : undefined;
+    })
+    .filter(Boolean);
+
+  return `{\n${codeLines.join('\n')}\n}`;
+}
+
+export async function mdxLoader(
+  this: LoaderContext<Options>,
+  fileString: string,
+): Promise<void> {
+  const callback = this.async();
+  const filePath = this.resourcePath;
+  const reqOptions = this.getOptions() ?? {};
+
+  const {frontMatter, content: contentWithTitle} = parseFrontMatter(fileString);
+
+  const {content, contentTitle} = parseMarkdownContentTitle(contentWithTitle, {
+    removeContentTitle: reqOptions.removeContentTitle,
+  });
+
+  const hasFrontMatter = Object.keys(frontMatter).length > 0;
+
+  if (!compilerCache.has(this.query)) {
+    const options: Options = {
+      ...reqOptions,
+      remarkPlugins: [
+        ...(reqOptions.beforeDefaultRemarkPlugins ?? []),
+        ...DEFAULT_OPTIONS.remarkPlugins,
+        [
+          transformImage,
+          {
+            staticDirs: reqOptions.staticDirs,
+            siteDir: reqOptions.siteDir,
+          },
+        ],
+        [
+          transformLinks,
+          {
+            staticDirs: reqOptions.staticDirs,
+            siteDir: reqOptions.siteDir,
+          },
+        ],
+        ...(reqOptions.remarkPlugins ?? []),
+      ],
+      rehypePlugins: [
+        ...(reqOptions.beforeDefaultRehypePlugins ?? []),
+        ...DEFAULT_OPTIONS.rehypePlugins,
+        ...(reqOptions.rehypePlugins ?? []),
+      ],
+    };
+    compilerCache.set(this.query, [createCompiler(options), options]);
+  }
+
+  const [compiler, options] = compilerCache.get(this.query)!;
+
+  let result: string;
+  try {
+    result = await compiler
+      .process({
+        contents: content,
+        path: this.resourcePath,
+      })
+      .then((res) => res.toString());
+  } catch (err) {
+    return callback(err as Error);
+  }
+
+  // MDX partials are MDX files starting with _ or in a folder starting with _
+  // Partial are not expected to have associated metadata files or front matter
+  const isMDXPartial = options.isMDXPartial?.(filePath);
+  if (isMDXPartial && hasFrontMatter) {
+    const errorMessage = `Docusaurus MDX partial files should not contain front matter.
+Those partial files use the _ prefix as a convention by default, but this is configurable.
+File at ${filePath} contains front matter that will be ignored:
+${JSON.stringify(frontMatter, null, 2)}`;
+
+    if (!options.isMDXPartialFrontMatterWarningDisabled) {
+      const shouldError = process.env.NODE_ENV === 'test' || process.env.CI;
+      if (shouldError) {
+        return callback(new Error(errorMessage));
+      }
+      logger.warn(errorMessage);
+    }
+  }
+
+  function getMetadataPath(): string | undefined {
+    if (!isMDXPartial) {
+      // Read metadata for this MDX and export it.
+      if (options.metadataPath && typeof options.metadataPath === 'function') {
+        return options.metadataPath(filePath);
+      }
+    }
+    return undefined;
+  }
+
+  const metadataPath = getMetadataPath();
+  if (metadataPath) {
+    this.addDependency(metadataPath);
+  }
+
+  const metadataJsonString = metadataPath
+    ? await readMetadataPath(metadataPath)
+    : undefined;
+
+  const metadata = metadataJsonString
+    ? JSON.parse(metadataJsonString)
+    : undefined;
+
+  const assets =
+    reqOptions.createAssets && metadata
+      ? reqOptions.createAssets({frontMatter, metadata})
+      : undefined;
+
+  const exportsCode = `
+export const frontMatter = ${stringifyObject(frontMatter)};
+export const contentTitle = ${stringifyObject(contentTitle)};
+${metadataJsonString ? `export const metadata = ${metadataJsonString};` : ''}
+${assets ? `export const assets = ${createAssetsExportCode(assets)};` : ''}
+`;
+
+  const code = `
+${pragma}
+import React from 'react';
+import { mdx } from '@mdx-js/react';
+
+${exportsCode}
+${result}
+`;
+
+  return callback(null, code);
+}

package/src/remark/toc/index.ts

@@ -13,7 +13,7 @@ import toString from 'mdast-util-to-string';
 import visit from 'unist-util-visit';
 import {toValue} from '../utils';
 
-import type {TOCItem} from '@docusaurus/types';
+import type {TOCItem} from '../..';
 import type {Node, Parent} from 'unist';
 import type {Heading, Literal} from 'mdast';
 import type {Transformer} from 'unified';

package/src/mdx-loader.d.ts

@@ -1,37 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-import type {Plugin} from 'unified';
-import type {TOCItem} from '@docusaurus/types';
-
-export type MDXPlugin =
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  [Plugin<any[]>, any] | Plugin<any[]>;
-export type MDXOptions = {
-  remarkPlugins: MDXPlugin[];
-  rehypePlugins: MDXPlugin[];
-  beforeDefaultRemarkPlugins: MDXPlugin[];
-  beforeDefaultRehypePlugins: MDXPlugin[];
-};
-
-export type LoadedMDXContent<FrontMatter, Metadata, Assets = undefined> = {
-  /** As verbatim declared in the MDX document. */
-  readonly frontMatter: FrontMatter;
-  /** As provided by the content plugin. */
-  readonly metadata: Metadata;
-  /** A list of TOC items (headings). */
-  readonly toc: readonly TOCItem[];
-  /** First h1 title before any content. */
-  readonly contentTitle: string | undefined;
-  /**
-   * Usually image assets that may be collocated like `./img/thumbnail.png`.
-   * The loader would also bundle these assets and the client should use these
-   * in priority.
-   */
-  readonly assets: Assets;
-  (): JSX.Element;
-};