@docusaurus/mdx-loader 2.0.0-beta.12faed89d → 2.0.0-beta.14

package/lib/remark/transformLinks/index.js

@@ -0,0 +1,107 @@
+"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 });
+const tslib_1 = require("tslib");
+const utils_1 = require("@docusaurus/utils");
+const unist_util_visit_1 = (0, tslib_1.__importDefault)(require("unist-util-visit"));
+const path_1 = (0, tslib_1.__importDefault)(require("path"));
+const url_1 = (0, tslib_1.__importDefault)(require("url"));
+const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
+const escape_html_1 = (0, tslib_1.__importDefault)(require("escape-html"));
+const utils_2 = require("../utils");
+const { loaders: { inlineMarkdownLinkFileLoader }, } = (0, utils_1.getFileLoaderUtils)();
+const hashRegex = /#.*$/;
+async function ensureAssetFileExist(fileSystemAssetPath, sourceFilePath) {
+    const assetExists = await fs_extra_1.default.pathExists(fileSystemAssetPath);
+    if (!assetExists) {
+        throw new Error(`Asset ${(0, utils_1.toMessageRelativeFilePath)(fileSystemAssetPath)} used in ${(0, utils_1.toMessageRelativeFilePath)(sourceFilePath)} not found.`);
+    }
+}
+// transform the link node to a jsx link with a require() call
+function toAssetRequireNode({ node, filePath, requireAssetPath, }) {
+    let relativeRequireAssetPath = (0, utils_1.posixPath)(path_1.default.relative(path_1.default.dirname(filePath), requireAssetPath));
+    const hash = hashRegex.test(node.url)
+        ? node.url.substr(node.url.indexOf('#'))
+        : '';
+    // nodejs does not like require("assets/file.pdf")
+    relativeRequireAssetPath = relativeRequireAssetPath.startsWith('.')
+        ? relativeRequireAssetPath
+        : `./${relativeRequireAssetPath}`;
+    const href = `require('${inlineMarkdownLinkFileLoader}${(0, utils_1.escapePath)(relativeRequireAssetPath)}').default${hash ? ` + '${hash}'` : ''}`;
+    const children = (0, utils_2.stringifyContent)(node);
+    const title = node.title ? ` title="${(0, escape_html_1.default)(node.title)}"` : '';
+    node.type = 'jsx';
+    node.value = `<a target="_blank" href={${href}}${title}>${children}</a>`;
+}
+// If the link looks like an asset link, we'll link to the asset,
+// and use a require("assetUrl") (using webpack url-loader/file-loader)
+// instead of navigating to such link
+async function convertToAssetLinkIfNeeded(node, { filePath, siteDir, staticDirs }) {
+    const assetPath = node.url.replace(hashRegex, '');
+    const hasSiteAlias = assetPath.startsWith('@site/');
+    const hasAssetLikeExtension = path_1.default.extname(assetPath) && !assetPath.match(/#|.md|.mdx|.html/);
+    const looksLikeAssetLink = hasSiteAlias || hasAssetLikeExtension;
+    if (!looksLikeAssetLink) {
+        return;
+    }
+    function toAssetLinkNode(requireAssetPath) {
+        toAssetRequireNode({
+            node,
+            filePath,
+            requireAssetPath,
+        });
+    }
+    if (assetPath.startsWith('@site/')) {
+        const fileSystemAssetPath = path_1.default.join(siteDir, assetPath.replace('@site/', ''));
+        await ensureAssetFileExist(fileSystemAssetPath, filePath);
+        toAssetLinkNode(fileSystemAssetPath);
+    }
+    else if (path_1.default.isAbsolute(assetPath)) {
+        // eslint-disable-next-line no-restricted-syntax
+        for (const staticDir of staticDirs) {
+            const fileSystemAssetPath = path_1.default.join(staticDir, assetPath);
+            if (await fs_extra_1.default.pathExists(fileSystemAssetPath)) {
+                toAssetLinkNode(fileSystemAssetPath);
+                return;
+            }
+        }
+    }
+    else {
+        const fileSystemAssetPath = path_1.default.join(path_1.default.dirname(filePath), assetPath);
+        if (await fs_extra_1.default.pathExists(fileSystemAssetPath)) {
+            toAssetLinkNode(fileSystemAssetPath);
+        }
+    }
+}
+async function processLinkNode(node, options) {
+    var _a, _b, _c;
+    if (!node.url) {
+        // try to improve error feedback
+        // see https://github.com/facebook/docusaurus/issues/3309#issuecomment-690371675
+        const title = node.title || ((_a = node.children[0]) === null || _a === void 0 ? void 0 : _a.value) || '?';
+        const line = ((_c = (_b = node === null || node === void 0 ? void 0 : node.position) === null || _b === void 0 ? void 0 : _b.start) === null || _c === void 0 ? void 0 : _c.line) || '?';
+        throw new Error(`Markdown link URL is mandatory in "${(0, utils_1.toMessageRelativeFilePath)(options.filePath)}" file (title: ${title}, line: ${line}).`);
+    }
+    const parsedUrl = url_1.default.parse(node.url);
+    if (parsedUrl.protocol) {
+        return;
+    }
+    await convertToAssetLinkIfNeeded(node, options);
+}
+const plugin = (options) => {
+    const transformer = async (root) => {
+        const promises = [];
+        (0, unist_util_visit_1.default)(root, 'link', (node) => {
+            promises.push(processLinkNode(node, options));
+        });
+        await Promise.all(promises);
+    };
+    return transformer;
+};
+exports.default = plugin;
+//# sourceMappingURL=index.js.map

package/lib/remark/transformLinks/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/remark/transformLinks/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,6CAK2B;AAC3B,qFAAqC;AACrC,6DAAwB;AACxB,2DAAsB;AACtB,qEAA0B;AAC1B,2EAAqC;AACrC,oCAA0C;AAI1C,MAAM,EACJ,OAAO,EAAE,EAAC,4BAA4B,EAAC,GACxC,GAAG,IAAA,0BAAkB,GAAE,CAAC;AACzB,MAAM,SAAS,GAAG,MAAM,CAAC;AAQzB,KAAK,UAAU,oBAAoB,CACjC,mBAA2B,EAC3B,cAAsB;IAEtB,MAAM,WAAW,GAAG,MAAM,kBAAE,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;IAC7D,IAAI,CAAC,WAAW,EAAE;QAChB,MAAM,IAAI,KAAK,CACb,SAAS,IAAA,iCAAyB,EAChC,mBAAmB,CACpB,YAAY,IAAA,iCAAyB,EAAC,cAAc,CAAC,aAAa,CACpE,CAAC;KACH;AACH,CAAC;AAED,8DAA8D;AAC9D,SAAS,kBAAkB,CAAC,EAC1B,IAAI,EACJ,QAAQ,EACR,gBAAgB,GAKjB;IACC,IAAI,wBAAwB,GAAG,IAAA,iBAAS,EACtC,cAAI,CAAC,QAAQ,CAAC,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,gBAAgB,CAAC,CACxD,CAAC;IACF,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;QACnC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACxC,CAAC,CAAC,EAAE,CAAC;IAEP,kDAAkD;IAClD,wBAAwB,GAAG,wBAAwB,CAAC,UAAU,CAAC,GAAG,CAAC;QACjE,CAAC,CAAC,wBAAwB;QAC1B,CAAC,CAAC,KAAK,wBAAwB,EAAE,CAAC;IAEpC,MAAM,IAAI,GAAG,YAAY,4BAA4B,GAAG,IAAA,kBAAU,EAChE,wBAAwB,CACzB,aAAa,IAAI,CAAC,CAAC,CAAC,OAAO,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAC3C,MAAM,QAAQ,GAAG,IAAA,wBAAgB,EAAC,IAAI,CAAC,CAAC;IACxC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,IAAA,qBAAU,EAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAEpE,IAA2B,CAAC,IAAI,GAAG,KAAK,CAAC;IAExC,IACD,CAAC,KAAK,GAAG,4BAA4B,IAAI,IAAI,KAAK,IAAI,QAAQ,MAAM,CAAC;AACxE,CAAC;AAED,iEAAiE;AACjE,uEAAuE;AACvE,qCAAqC;AACrC,KAAK,UAAU,0BAA0B,CACvC,IAAU,EACV,EAAC,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAgB;IAE9C,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IAElD,MAAM,YAAY,GAAG,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACpD,MAAM,qBAAqB,GACzB,cAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAElE,MAAM,kBAAkB,GAAG,YAAY,IAAI,qBAAqB,CAAC;IAEjE,IAAI,CAAC,kBAAkB,EAAE;QACvB,OAAO;KACR;IAED,SAAS,eAAe,CAAC,gBAAwB;QAC/C,kBAAkB,CAAC;YACjB,IAAI;YACJ,QAAQ;YACR,gBAAgB;SACjB,CAAC,CAAC;IACL,CAAC;IAED,IAAI,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;QAClC,MAAM,mBAAmB,GAAG,cAAI,CAAC,IAAI,CACnC,OAAO,EACP,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAChC,CAAC;QACF,MAAM,oBAAoB,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAC;QAC1D,eAAe,CAAC,mBAAmB,CAAC,CAAC;KACtC;SAAM,IAAI,cAAI,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;QACrC,gDAAgD;QAChD,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE;YAClC,MAAM,mBAAmB,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;YAC5D,IAAI,MAAM,kBAAE,CAAC,UAAU,CAAC,mBAAmB,CAAC,EAAE;gBAC5C,eAAe,CAAC,mBAAmB,CAAC,CAAC;gBACrC,OAAO;aACR;SACF;KACF;SAAM;QACL,MAAM,mBAAmB,GAAG,cAAI,CAAC,IAAI,CAAC,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,CAAC;QACzE,IAAI,MAAM,kBAAE,CAAC,UAAU,CAAC,mBAAmB,CAAC,EAAE;YAC5C,eAAe,CAAC,mBAAmB,CAAC,CAAC;SACtC;KACF;AACH,CAAC;AAED,KAAK,UAAU,eAAe,CAAC,IAAU,EAAE,OAAsB;;IAC/D,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;QACb,gCAAgC;QAChC,gFAAgF;QAChF,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,KAAI,MAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAa,0CAAE,KAAK,CAAA,IAAI,GAAG,CAAC;QACxE,MAAM,IAAI,GAAG,CAAA,MAAA,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,0CAAE,KAAK,0CAAE,IAAI,KAAI,GAAG,CAAC;QAChD,MAAM,IAAI,KAAK,CACb,sCAAsC,IAAA,iCAAyB,EAC7D,OAAO,CAAC,QAAQ,CACjB,kBAAkB,KAAK,WAAW,IAAI,IAAI,CAC5C,CAAC;KACH;IAED,MAAM,SAAS,GAAG,aAAG,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACtC,IAAI,SAAS,CAAC,QAAQ,EAAE;QACtB,OAAO;KACR;IAED,MAAM,0BAA0B,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAClD,CAAC;AAED,MAAM,MAAM,GAA4B,CAAC,OAAO,EAAE,EAAE;IAClD,MAAM,WAAW,GAAgB,KAAK,EAAE,IAAI,EAAE,EAAE;QAC9C,MAAM,QAAQ,GAAoB,EAAE,CAAC;QACrC,IAAA,0BAAK,EAAC,IAAI,EAAE,MAAM,EAAE,CAAC,IAAU,EAAE,EAAE;YACjC,QAAQ,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;QAChD,CAAC,CAAC,CAAC;QACH,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC9B,CAAC,CAAC;IACF,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;AAEF,kBAAe,MAAM,CAAC"}

package/lib/remark/unwrapMdxCodeBlocks/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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 { Transformer, Processor } from 'unified';
+declare function plugin(this: Processor): Transformer;
+export default plugin;
+//# sourceMappingURL=index.d.ts.map

package/lib/remark/unwrapMdxCodeBlocks/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/remark/unwrapMdxCodeBlocks/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,KAAK,EAAC,WAAW,EAAE,SAAS,EAAC,MAAM,SAAS,CAAC;AAQpD,iBAAS,MAAM,CAAC,IAAI,EAAE,SAAS,GAAG,WAAW,CAiB5C;AAED,eAAe,MAAM,CAAC"}

package/lib/remark/unwrapMdxCodeBlocks/index.js

@@ -0,0 +1,29 @@
+"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 });
+const tslib_1 = require("tslib");
+const unist_util_visit_1 = (0, tslib_1.__importDefault)(require("unist-util-visit"));
+// This plugin is mostly to help integrating Docusaurus with translation systems
+// that do not support well MDX embedded JSX syntax (like Crowdin)
+// We wrap the JSX syntax in code blocks so that translation tools don't mess-up with the markup
+// But the JSX inside such code blocks should still be evaluated as JSX
+// See https://github.com/facebook/docusaurus/pull/4278
+function plugin() {
+    const transformer = (root) => {
+        (0, unist_util_visit_1.default)(root, 'code', (node, _index, parent) => {
+            if (node.lang === 'mdx-code-block') {
+                const newChildren = this.parse(node.value).children;
+                // Replace the mdx code block by its content, parsed
+                parent.children.splice(parent.children.indexOf(node), 1, ...newChildren);
+            }
+        });
+    };
+    return transformer;
+}
+exports.default = plugin;
+//# sourceMappingURL=index.js.map

package/lib/remark/unwrapMdxCodeBlocks/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/remark/unwrapMdxCodeBlocks/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,qFAAqC;AAIrC,gFAAgF;AAChF,kEAAkE;AAClE,gGAAgG;AAChG,uEAAuE;AACvE,uDAAuD;AACvD,SAAS,MAAM;IACb,MAAM,WAAW,GAAgB,CAAC,IAAI,EAAE,EAAE;QACxC,IAAA,0BAAK,EAAC,IAAI,EAAE,MAAM,EAAE,CAAC,IAAU,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE;YACjD,IAAI,IAAI,CAAC,IAAI,KAAK,gBAAgB,EAAE;gBAClC,MAAM,WAAW,GAAI,IAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAY,CAAC,QAAQ,CAAC;gBAEjE,oDAAoD;gBACpD,MAAO,CAAC,QAAQ,CAAC,MAAM,CACrB,MAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,EAC9B,CAAC,EACD,GAAG,WAAW,CACf,CAAC;aACH;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,kBAAe,MAAM,CAAC"}

package/lib/remark/utils/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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 { Parent } from 'unist';
+import type { StaticPhrasingContent, Heading } from 'mdast';
+export declare function stringifyContent(node: Parent): string;
+export declare function toValue(node: StaticPhrasingContent | Heading): string;
+//# sourceMappingURL=index.d.ts.map

package/lib/remark/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/remark/utils/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,OAAO,CAAC;AAClC,OAAO,KAAK,EAAC,qBAAqB,EAAE,OAAO,EAAC,MAAM,OAAO,CAAC;AAE1D,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAIrD;AAED,wBAAgB,OAAO,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,GAAG,MAAM,CAoBrE"}

package/lib/remark/utils/index.js

@@ -0,0 +1,40 @@
+"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.toValue = exports.stringifyContent = void 0;
+const tslib_1 = require("tslib");
+const escape_html_1 = (0, tslib_1.__importDefault)(require("escape-html"));
+const mdast_util_to_string_1 = (0, tslib_1.__importDefault)(require("mdast-util-to-string"));
+function stringifyContent(node) {
+    return (node.children || [])
+        .map(toValue)
+        .join('');
+}
+exports.stringifyContent = stringifyContent;
+function toValue(node) {
+    if (node && node.type) {
+        switch (node.type) {
+            case 'text':
+                return (0, escape_html_1.default)(node.value);
+            case 'heading':
+                return stringifyContent(node);
+            case 'inlineCode':
+                return `<code>${(0, escape_html_1.default)(node.value)}</code>`;
+            case 'emphasis':
+                return `<em>${stringifyContent(node)}</em>`;
+            case 'strong':
+                return `<strong>${stringifyContent(node)}</strong>`;
+            case 'delete':
+                return `<del>${stringifyContent(node)}</del>`;
+            default:
+        }
+    }
+    return (0, mdast_util_to_string_1.default)(node);
+}
+exports.toValue = toValue;
+//# sourceMappingURL=index.js.map

package/lib/remark/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/remark/utils/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,2EAAqC;AACrC,6FAA4C;AAI5C,SAAgB,gBAAgB,CAAC,IAAY;IAC3C,OAAQ,CAAC,IAAI,CAAC,QAAQ,IAAI,EAAE,CAA6B;SACtD,GAAG,CAAC,OAAO,CAAC;SACZ,IAAI,CAAC,EAAE,CAAC,CAAC;AACd,CAAC;AAJD,4CAIC;AAED,SAAgB,OAAO,CAAC,IAAqC;IAC3D,IAAI,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE;QACrB,QAAQ,IAAI,CAAC,IAAI,EAAE;YACjB,KAAK,MAAM;gBACT,OAAO,IAAA,qBAAU,EAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAChC,KAAK,SAAS;gBACZ,OAAO,gBAAgB,CAAC,IAAI,CAAC,CAAC;YAChC,KAAK,YAAY;gBACf,OAAO,SAAS,IAAA,qBAAU,EAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC;YAClD,KAAK,UAAU;gBACb,OAAO,OAAO,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC;YAC9C,KAAK,QAAQ;gBACX,OAAO,WAAW,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC;YACtD,KAAK,QAAQ;gBACX,OAAO,QAAQ,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC;YAChD,QAAQ;SACT;KACF;IAED,OAAO,IAAA,8BAAQ,EAAC,IAAI,CAAC,CAAC;AACxB,CAAC;AApBD,0BAoBC"}

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@docusaurus/mdx-loader",
-  "version": "2.0.0-beta.12faed89d",
+  "version": "2.0.0-beta.14",
   "description": "Docusaurus Loader for MDX",
-  "main": "src/index.js",
-  "types": "src/index.d.ts",
+  "main": "lib/index.js",
+  "types": "src/mdx-loader.d.ts",
   "publishConfig": {
     "access": "public"
   },
@@ -18,26 +18,30 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@babel/parser": "^7.12.16",
-    "@babel/traverse": "^7.12.13",
-    "@docusaurus/core": "2.0.0-beta.12faed89d",
-    "@docusaurus/utils": "2.0.0-beta.12faed89d",
+    "@babel/parser": "^7.16.4",
+    "@babel/traverse": "^7.16.3",
+    "@docusaurus/logger": "2.0.0-beta.14",
+    "@docusaurus/utils": "2.0.0-beta.14",
     "@mdx-js/mdx": "^1.6.21",
     "@mdx-js/react": "^1.6.21",
     "escape-html": "^1.0.3",
     "file-loader": "^6.2.0",
     "fs-extra": "^10.0.0",
-    "github-slugger": "^1.3.0",
     "gray-matter": "^4.0.3",
     "mdast-util-to-string": "^2.0.0",
     "remark-emoji": "^2.1.0",
     "stringify-object": "^3.3.0",
+    "tslib": "^2.3.1",
     "unist-util-visit": "^2.0.2",
     "url-loader": "^4.1.1",
-    "webpack": "^5.40.0"
+    "webpack": "^5.61.0"
   },
   "devDependencies": {
-    "@docusaurus/types": "2.0.0-beta.12faed89d",
+    "@docusaurus/types": "2.0.0-beta.14",
+    "@types/escape-html": "^1.0.1",
+    "@types/mdast": "^3.0.7",
+    "@types/stringify-object": "^3.3.1",
+    "@types/unist": "^2.0.6",
     "remark": "^12.0.0",
     "remark-mdx": "^1.6.21",
     "to-vfile": "^6.0.0",
@@ -49,7 +53,7 @@
     "react-dom": "^16.8.4 || ^17.0.0"
   },
   "engines": {
-    "node": ">=12.13.0"
+    "node": ">=14"
   },
-  "gitHead": "1430dbacfbe9da59a17ce395ed29bdbddaf90049"
+  "gitHead": "c4824a8937d8f1aa0806667749cbc74058e2b294"
 }

package/src/deps.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 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.
+ */
+
+// 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 {RemarkOrRehypePlugin} from '@docusaurus/mdx-loader';
+
+  namespace mdx {
+    interface Options {
+      filepath?: string;
+      skipExport?: boolean;
+      wrapExport?: string;
+      remarkPlugins?: RemarkOrRehypePlugin[];
+      rehypePlugins?: RemarkOrRehypePlugin[];
+    }
+
+    function sync(content: string, options?: Options): string;
+    function createMdxAstCompiler(options?: Options): Processor;
+    function createCompiler(options?: Options): Processor;
+  }
+  function mdx(content: string, options?: mdx.Options): Promise<string>;
+
+  export default mdx;
+}

package/src/index.ts

@@ -0,0 +1,216 @@
+/**
+ * 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 {readFile} from 'fs-extra';
+import mdx 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 {RemarkAndRehypePluginOptions} from '@docusaurus/mdx-loader';
+import type {LoaderContext} from 'webpack';
+
+const {
+  loaders: {inlineMarkdownImageFileLoader},
+} = getFileLoaderUtils();
+
+const DEFAULT_OPTIONS: RemarkAndRehypePluginOptions = {
+  rehypePlugins: [],
+  remarkPlugins: [unwrapMdxCodeBlocks, emoji, headings, toc],
+  beforeDefaultRemarkPlugins: [],
+  beforeDefaultRehypePlugins: [],
+};
+
+type Options = RemarkAndRehypePluginOptions & {
+  staticDirs: string[];
+  siteDir: string;
+  isMDXPartial?: (filePath: string) => boolean;
+  isMDXPartialFrontMatterWarningDisabled?: boolean;
+  removeContentTitle?: boolean;
+  metadataPath?: string | ((filePath: string) => string);
+  createAssets?: (metadata: {
+    frontMatter: Record<string, unknown>;
+    metadata: Record<string, unknown>;
+  }) => Record<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 readFile(metadataPath, 'utf8');
+  } catch (e) {
+    throw new Error(
+      `MDX loader can't read MDX metadata file for path ${metadataPath}. Maybe the isMDXPartial option function was not provided?`,
+    );
+  }
+}
+
+// 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: Record<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;
+
+  const options: Options = {
+    ...reqOptions,
+    remarkPlugins: [
+      ...(reqOptions.beforeDefaultRemarkPlugins || []),
+      ...DEFAULT_OPTIONS.remarkPlugins,
+      [transformImage, {staticDirs: reqOptions.staticDirs, filePath}],
+      [
+        transformLinks,
+        {
+          staticDirs: reqOptions.staticDirs,
+          filePath,
+          siteDir: reqOptions.siteDir,
+        },
+      ],
+      ...(reqOptions.remarkPlugins || []),
+    ],
+    rehypePlugins: [
+      ...(reqOptions.beforeDefaultRehypePlugins || []),
+      ...DEFAULT_OPTIONS.rehypePlugins,
+      ...(reqOptions.rehypePlugins || []),
+    ],
+    filepath: filePath,
+  };
+
+  let result;
+  try {
+    result = await mdx(content, options);
+  } 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 an associated metadata file or frontmatter
+  const isMDXPartial = options.isMDXPartial && options.isMDXPartial(filePath);
+  if (isMDXPartial && hasFrontMatter) {
+    const errorMessage = `Docusaurus MDX partial files should not contain FrontMatter.
+Those partial files use the _ prefix as a convention by default, but this is configurable.
+File at ${filePath} contains FrontMatter 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));
+      } else {
+        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 = `
+import React from 'react';
+import { mdx } from '@mdx-js/react';
+
+${exportsCode}
+${result}
+`;
+
+  return callback(null, code);
+}

package/src/{index.d.ts → mdx-loader.d.ts}

@@ -5,15 +5,14 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-type RemarkOrRehypePlugin =
-  // eslint-disable-next-line @typescript-eslint/ban-types
-  [Function, Record<string, unknown>] | Function;
+import type {Plugin} from 'unified';
 
-declare function docusaurusMdxLoader(fileString: string): string;
-
-export interface RemarkAndRehypePluginOptions {
+export type RemarkOrRehypePlugin =
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  [Plugin<any[]>, Record<string, unknown>] | Plugin<any[]>;
+export type RemarkAndRehypePluginOptions = {
   remarkPlugins: RemarkOrRehypePlugin[];
-  rehypePlugins: string[];
+  rehypePlugins: RemarkOrRehypePlugin[];
   beforeDefaultRemarkPlugins: RemarkOrRehypePlugin[];
   beforeDefaultRehypePlugins: RemarkOrRehypePlugin[];
-}
+};

package/src/remark/headings/{index.js → index.ts}

@@ -7,29 +7,33 @@
 
 /* Based on remark-slug (https://github.com/remarkjs/remark-slug) and gatsby-remark-autolink-headers (https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby-remark-autolink-headers) */
 
-const {parseMarkdownHeadingId} = require('@docusaurus/utils');
-const visit = require('unist-util-visit');
-const toString = require('mdast-util-to-string');
-const slugs = require('github-slugger')();
+import {parseMarkdownHeadingId, createSlugger} from '@docusaurus/utils';
+import visit, {Visitor} from 'unist-util-visit';
+import toString from 'mdast-util-to-string';
+import type {Transformer} from 'unified';
+import type {Parent} from 'unist';
+import type {Heading, Text} from 'mdast';
 
-function headings() {
-  const transformer = (ast) => {
-    slugs.reset();
+function headings(): Transformer {
+  const transformer: Transformer = (ast) => {
+    const slugs = createSlugger();
 
-    function visitor(headingNode) {
-      const data = headingNode.data || (headingNode.data = {}); // eslint-disable-line
-      const properties = data.hProperties || (data.hProperties = {});
+    const visitor: Visitor<Heading> = (headingNode) => {
+      const data = headingNode.data || (headingNode.data = {});
+      const properties = (data.hProperties || (data.hProperties = {})) as {
+        id: string;
+      };
       let {id} = properties;
 
       if (id) {
-        id = slugs.slug(id, true);
+        id = slugs.slug(id, {maintainCase: true});
       } else {
         const headingTextNodes = headingNode.children.filter(
           ({type}) => !['html', 'jsx'].includes(type),
         );
         const heading = toString(
           headingTextNodes.length > 0
-            ? {children: headingTextNodes}
+            ? ({children: headingTextNodes} as Parent)
             : headingNode,
         );
 
@@ -42,8 +46,9 @@ function headings() {
           // When there's an id, it is always in the last child node
           // Sometimes heading is in multiple "parts" (** syntax creates a child node):
           // ## part1 *part2* part3 {#id}
-          const lastNode =
-            headingNode.children[headingNode.children.length - 1];
+          const lastNode = headingNode.children[
+            headingNode.children.length - 1
+          ] as Text;
 
           if (headingNode.children.length > 1) {
             const lastNodeText = parseMarkdownHeadingId(lastNode.value).text;
@@ -63,7 +68,7 @@ function headings() {
 
       data.id = id;
       properties.id = id;
-    }
+    };
 
     visit(ast, 'heading', visitor);
   };
@@ -71,4 +76,4 @@ function headings() {
   return transformer;
 }
 
-module.exports = headings;
+export default headings;