@docusaurus/plugin-content-pages 3.5.2 → 3.6.0-canary-6132

package/lib/index.d.ts

@@ -6,5 +6,5 @@
  */
 import type { LoadContext, Plugin } from '@docusaurus/types';
 import type { PluginOptions, LoadedContent } from '@docusaurus/plugin-content-pages';
-export default function pluginContentPages(context: LoadContext, options: PluginOptions): Plugin<LoadedContent | null>;
+export default function pluginContentPages(context: LoadContext, options: PluginOptions): Promise<Plugin<LoadedContent | null>>;
 export { validateOptions } from './options';

package/lib/index.js

@@ -12,13 +12,47 @@ const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
 const utils_1 = require("@docusaurus/utils");
+const mdx_loader_1 = require("@docusaurus/mdx-loader");
 const routes_1 = require("./routes");
 const content_1 = require("./content");
-function pluginContentPages(context, options) {
+async function pluginContentPages(context, options) {
     const { siteConfig, siteDir, generatedFilesDir } = context;
     const contentPaths = (0, content_1.createPagesContentPaths)({ context, options });
     const pluginDataDirRoot = path_1.default.join(generatedFilesDir, 'docusaurus-plugin-content-pages');
     const dataDir = path_1.default.join(pluginDataDirRoot, options.id ?? utils_1.DEFAULT_PLUGIN_ID);
+    async function createPagesMDXLoaderRule() {
+        const { admonitions, rehypePlugins, remarkPlugins, recmaPlugins, beforeDefaultRehypePlugins, beforeDefaultRemarkPlugins, } = options;
+        const contentDirs = (0, content_1.getContentPathList)(contentPaths);
+        return (0, mdx_loader_1.createMDXLoaderRule)({
+            include: contentDirs
+                // Trailing slash is important, see https://github.com/facebook/docusaurus/pull/3970
+                .map(utils_1.addTrailingPathSeparator),
+            options: {
+                useCrossCompilerCache: siteConfig.future.experimental_faster.mdxCrossCompilerCache,
+                admonitions,
+                remarkPlugins,
+                rehypePlugins,
+                recmaPlugins,
+                beforeDefaultRehypePlugins,
+                beforeDefaultRemarkPlugins,
+                staticDirs: siteConfig.staticDirectories.map((dir) => path_1.default.resolve(siteDir, dir)),
+                siteDir,
+                isMDXPartial: (0, utils_1.createAbsoluteFilePathMatcher)(options.exclude, contentDirs),
+                metadataPath: (mdxPath) => {
+                    // Note that metadataPath must be the same/in-sync as
+                    // the path from createData for each MDX.
+                    const aliasedSource = (0, utils_1.aliasedSitePath)(mdxPath, siteDir);
+                    return path_1.default.join(dataDir, `${(0, utils_1.docuHash)(aliasedSource)}.json`);
+                },
+                // createAssets converts relative paths to require() calls
+                createAssets: ({ frontMatter }) => ({
+                    image: frontMatter.image,
+                }),
+                markdownConfig: siteConfig.markdown,
+            },
+        });
+    }
+    const pagesMDXLoaderRule = await createPagesMDXLoaderRule();
     return {
         name: 'docusaurus-plugin-content-pages',
         getPathsToWatch() {
@@ -38,48 +72,9 @@ function pluginContentPages(context, options) {
             await (0, routes_1.createAllRoutes)({ content, options, actions });
         },
         configureWebpack() {
-            const { admonitions, rehypePlugins, remarkPlugins, recmaPlugins, beforeDefaultRehypePlugins, beforeDefaultRemarkPlugins, } = options;
-            const contentDirs = (0, content_1.getContentPathList)(contentPaths);
-            function createMDXLoader() {
-                const loaderOptions = {
-                    admonitions,
-                    remarkPlugins,
-                    rehypePlugins,
-                    recmaPlugins,
-                    beforeDefaultRehypePlugins,
-                    beforeDefaultRemarkPlugins,
-                    staticDirs: siteConfig.staticDirectories.map((dir) => path_1.default.resolve(siteDir, dir)),
-                    siteDir,
-                    isMDXPartial: (0, utils_1.createAbsoluteFilePathMatcher)(options.exclude, contentDirs),
-                    metadataPath: (mdxPath) => {
-                        // Note that metadataPath must be the same/in-sync as
-                        // the path from createData for each MDX.
-                        const aliasedSource = (0, utils_1.aliasedSitePath)(mdxPath, siteDir);
-                        return path_1.default.join(dataDir, `${(0, utils_1.docuHash)(aliasedSource)}.json`);
-                    },
-                    // Assets allow to convert some relative images paths to
-                    // require(...) calls
-                    createAssets: ({ frontMatter }) => ({
-                        image: frontMatter.image,
-                    }),
-                    markdownConfig: siteConfig.markdown,
-                };
-                return {
-                    loader: require.resolve('@docusaurus/mdx-loader'),
-                    options: loaderOptions,
-                };
-            }
             return {
                 module: {
-                    rules: [
-                        {
-                            test: /\.mdx?$/i,
-                            include: contentDirs
-                                // Trailing slash is important, see https://github.com/facebook/docusaurus/pull/3970
-                                .map(utils_1.addTrailingPathSeparator),
-                            use: [createMDXLoader()],
-                        },
-                    ],
+                    rules: [pagesMDXLoaderRule],
                 },
             };
         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-pages",
-  "version": "3.5.2",
+  "version": "3.6.0-canary-6132",
   "description": "Pages plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-pages.d.ts",
@@ -18,11 +18,11 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "3.5.2",
-    "@docusaurus/mdx-loader": "3.5.2",
-    "@docusaurus/types": "3.5.2",
-    "@docusaurus/utils": "3.5.2",
-    "@docusaurus/utils-validation": "3.5.2",
+    "@docusaurus/core": "3.6.0-canary-6132",
+    "@docusaurus/mdx-loader": "3.6.0-canary-6132",
+    "@docusaurus/types": "3.6.0-canary-6132",
+    "@docusaurus/utils": "3.6.0-canary-6132",
+    "@docusaurus/utils-validation": "3.6.0-canary-6132",
     "fs-extra": "^11.1.1",
     "tslib": "^2.6.0",
     "webpack": "^5.88.1"
@@ -34,5 +34,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "eeec303dd773774ed5a023884800da0b061f6942"
+  "gitHead": "4930a868b86cafcb0786e2ddc6d400459127c4f6"
 }

package/src/index.ts

@@ -14,6 +14,7 @@ import {
   createAbsoluteFilePathMatcher,
   DEFAULT_PLUGIN_ID,
 } from '@docusaurus/utils';
+import {createMDXLoaderRule} from '@docusaurus/mdx-loader';
 import {createAllRoutes} from './routes';
 import {
   createPagesContentPaths,
@@ -26,13 +27,12 @@ import type {
   LoadedContent,
   PageFrontMatter,
 } from '@docusaurus/plugin-content-pages';
-import type {RuleSetUseItem} from 'webpack';
-import type {Options as MDXLoaderOptions} from '@docusaurus/mdx-loader/lib/loader';
+import type {RuleSetRule} from 'webpack';
 
-export default function pluginContentPages(
+export default async function pluginContentPages(
   context: LoadContext,
   options: PluginOptions,
-): Plugin<LoadedContent | null> {
+): Promise<Plugin<LoadedContent | null>> {
   const {siteConfig, siteDir, generatedFilesDir} = context;
 
   const contentPaths = createPagesContentPaths({context, options});
@@ -43,6 +43,55 @@ export default function pluginContentPages(
   );
   const dataDir = path.join(pluginDataDirRoot, options.id ?? DEFAULT_PLUGIN_ID);
 
+  async function createPagesMDXLoaderRule(): Promise<RuleSetRule> {
+    const {
+      admonitions,
+      rehypePlugins,
+      remarkPlugins,
+      recmaPlugins,
+      beforeDefaultRehypePlugins,
+      beforeDefaultRemarkPlugins,
+    } = options;
+    const contentDirs = getContentPathList(contentPaths);
+
+    return createMDXLoaderRule({
+      include: contentDirs
+        // Trailing slash is important, see https://github.com/facebook/docusaurus/pull/3970
+        .map(addTrailingPathSeparator),
+      options: {
+        useCrossCompilerCache:
+          siteConfig.future.experimental_faster.mdxCrossCompilerCache,
+        admonitions,
+        remarkPlugins,
+        rehypePlugins,
+        recmaPlugins,
+        beforeDefaultRehypePlugins,
+        beforeDefaultRemarkPlugins,
+        staticDirs: siteConfig.staticDirectories.map((dir) =>
+          path.resolve(siteDir, dir),
+        ),
+        siteDir,
+        isMDXPartial: createAbsoluteFilePathMatcher(
+          options.exclude,
+          contentDirs,
+        ),
+        metadataPath: (mdxPath: string) => {
+          // Note that metadataPath must be the same/in-sync as
+          // the path from createData for each MDX.
+          const aliasedSource = aliasedSitePath(mdxPath, siteDir);
+          return path.join(dataDir, `${docuHash(aliasedSource)}.json`);
+        },
+        // createAssets converts relative paths to require() calls
+        createAssets: ({frontMatter}: {frontMatter: PageFrontMatter}) => ({
+          image: frontMatter.image,
+        }),
+        markdownConfig: siteConfig.markdown,
+      },
+    });
+  }
+
+  const pagesMDXLoaderRule = await createPagesMDXLoaderRule();
+
   return {
     name: 'docusaurus-plugin-content-pages',
 
@@ -68,63 +117,9 @@ export default function pluginContentPages(
     },
 
     configureWebpack() {
-      const {
-        admonitions,
-        rehypePlugins,
-        remarkPlugins,
-        recmaPlugins,
-        beforeDefaultRehypePlugins,
-        beforeDefaultRemarkPlugins,
-      } = options;
-      const contentDirs = getContentPathList(contentPaths);
-
-      function createMDXLoader(): RuleSetUseItem {
-        const loaderOptions: MDXLoaderOptions = {
-          admonitions,
-          remarkPlugins,
-          rehypePlugins,
-          recmaPlugins,
-          beforeDefaultRehypePlugins,
-          beforeDefaultRemarkPlugins,
-          staticDirs: siteConfig.staticDirectories.map((dir) =>
-            path.resolve(siteDir, dir),
-          ),
-          siteDir,
-          isMDXPartial: createAbsoluteFilePathMatcher(
-            options.exclude,
-            contentDirs,
-          ),
-          metadataPath: (mdxPath: string) => {
-            // Note that metadataPath must be the same/in-sync as
-            // the path from createData for each MDX.
-            const aliasedSource = aliasedSitePath(mdxPath, siteDir);
-            return path.join(dataDir, `${docuHash(aliasedSource)}.json`);
-          },
-          // Assets allow to convert some relative images paths to
-          // require(...) calls
-          createAssets: ({frontMatter}: {frontMatter: PageFrontMatter}) => ({
-            image: frontMatter.image,
-          }),
-          markdownConfig: siteConfig.markdown,
-        };
-
-        return {
-          loader: require.resolve('@docusaurus/mdx-loader'),
-          options: loaderOptions,
-        };
-      }
-
       return {
         module: {
-          rules: [
-            {
-              test: /\.mdx?$/i,
-              include: contentDirs
-                // Trailing slash is important, see https://github.com/facebook/docusaurus/pull/3970
-                .map(addTrailingPathSeparator),
-              use: [createMDXLoader()],
-            },
-          ],
+          rules: [pagesMDXLoaderRule],
         },
       };
     },