@docusaurus/plugin-content-pages 3.3.2 → 3.5.0

package/lib/content.d.ts

@@ -4,7 +4,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-/// <reference path="../src/plugin-content-pages.d.ts" />
 import type { LoadContext } from '@docusaurus/types';
 import type { PagesContentPaths } from './types';
 import type { PluginOptions, LoadedContent } from '@docusaurus/plugin-content-pages';

package/lib/content.js

@@ -6,7 +6,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadPagesContent = exports.getContentPathList = exports.createPagesContentPaths = void 0;
+exports.createPagesContentPaths = createPagesContentPaths;
+exports.getContentPathList = getContentPathList;
+exports.loadPagesContent = loadPagesContent;
 const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
@@ -23,11 +25,9 @@ function createPagesContentPaths({ context, options, }) {
         }),
     };
 }
-exports.createPagesContentPaths = createPagesContentPaths;
 function getContentPathList(contentPaths) {
     return [contentPaths.contentPathLocalized, contentPaths.contentPath];
 }
-exports.getContentPathList = getContentPathList;
 const isMarkdownSource = (source) => source.endsWith('.md') || source.endsWith('.mdx');
 async function loadPagesContent(params) {
     const { options } = params;
@@ -47,7 +47,6 @@ async function loadPagesContent(params) {
         return res !== undefined;
     });
 }
-exports.loadPagesContent = loadPagesContent;
 async function processPageSourceFile(relativeSource, params) {
     const { context, options, contentPaths } = params;
     const { siteConfig, baseUrl, siteDir, i18n } = context;

package/lib/frontMatter.d.ts

@@ -4,7 +4,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-/// <reference path="../src/plugin-content-pages.d.ts" />
 import type { PageFrontMatter } from '@docusaurus/plugin-content-pages';
 export declare function validatePageFrontMatter(frontMatter: {
     [key: string]: unknown;

package/lib/frontMatter.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validatePageFrontMatter = void 0;
+exports.validatePageFrontMatter = validatePageFrontMatter;
 const utils_validation_1 = require("@docusaurus/utils-validation");
 const PageFrontMatterSchema = utils_validation_1.Joi.object({
     // See https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
@@ -23,4 +23,3 @@ const PageFrontMatterSchema = utils_validation_1.Joi.object({
 function validatePageFrontMatter(frontMatter) {
     return (0, utils_validation_1.validateFrontMatter)(frontMatter, PageFrontMatterSchema);
 }
-exports.validatePageFrontMatter = validatePageFrontMatter;

package/lib/index.d.ts

@@ -4,7 +4,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-/// <reference path="../src/plugin-content-pages.d.ts" />
 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>;

package/lib/index.js

@@ -7,6 +7,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateOptions = void 0;
+exports.default = pluginContentPages;
 const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
@@ -37,8 +38,37 @@ function pluginContentPages(context, options) {
             await (0, routes_1.createAllRoutes)({ content, options, actions });
         },
         configureWebpack() {
-            const { admonitions, rehypePlugins, remarkPlugins, beforeDefaultRehypePlugins, beforeDefaultRemarkPlugins, } = options;
+            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: [
@@ -47,40 +77,7 @@ function pluginContentPages(context, options) {
                             include: contentDirs
                                 // Trailing slash is important, see https://github.com/facebook/docusaurus/pull/3970
                                 .map(utils_1.addTrailingPathSeparator),
-                            use: [
-                                {
-                                    loader: require.resolve('@docusaurus/mdx-loader'),
-                                    options: {
-                                        admonitions,
-                                        remarkPlugins,
-                                        rehypePlugins,
-                                        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,
-                                    },
-                                },
-                                {
-                                    loader: path_1.default.resolve(__dirname, './markdownLoader.js'),
-                                    options: {
-                                    // siteDir,
-                                    // contentPath,
-                                    },
-                                },
-                            ].filter(Boolean),
+                            use: [createMDXLoader()],
                         },
                     ],
                 },
@@ -88,6 +85,5 @@ function pluginContentPages(context, options) {
         },
     };
 }
-exports.default = pluginContentPages;
 var options_1 = require("./options");
 Object.defineProperty(exports, "validateOptions", { enumerable: true, get: function () { return options_1.validateOptions; } });

package/lib/options.d.ts

@@ -4,7 +4,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-/// <reference path="../src/plugin-content-pages.d.ts" />
 import type { OptionValidationContext } from '@docusaurus/types';
 import type { PluginOptions, Options } from '@docusaurus/plugin-content-pages';
 export declare const DEFAULT_OPTIONS: PluginOptions;

package/lib/options.js

@@ -6,7 +6,8 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateOptions = exports.DEFAULT_OPTIONS = void 0;
+exports.DEFAULT_OPTIONS = void 0;
+exports.validateOptions = validateOptions;
 const utils_validation_1 = require("@docusaurus/utils-validation");
 const utils_1 = require("@docusaurus/utils");
 exports.DEFAULT_OPTIONS = {
@@ -17,6 +18,7 @@ exports.DEFAULT_OPTIONS = {
     mdxPageComponent: '@theme/MDXPage',
     remarkPlugins: [],
     rehypePlugins: [],
+    recmaPlugins: [],
     beforeDefaultRehypePlugins: [],
     beforeDefaultRemarkPlugins: [],
     admonitions: true,
@@ -32,6 +34,7 @@ const PluginOptionSchema = utils_validation_1.Joi.object({
     mdxPageComponent: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.mdxPageComponent),
     remarkPlugins: utils_validation_1.RemarkPluginsSchema.default(exports.DEFAULT_OPTIONS.remarkPlugins),
     rehypePlugins: utils_validation_1.RehypePluginsSchema.default(exports.DEFAULT_OPTIONS.rehypePlugins),
+    recmaPlugins: utils_validation_1.RecmaPluginsSchema.default(exports.DEFAULT_OPTIONS.recmaPlugins),
     beforeDefaultRehypePlugins: utils_validation_1.RehypePluginsSchema.default(exports.DEFAULT_OPTIONS.beforeDefaultRehypePlugins),
     beforeDefaultRemarkPlugins: utils_validation_1.RemarkPluginsSchema.default(exports.DEFAULT_OPTIONS.beforeDefaultRemarkPlugins),
     admonitions: utils_validation_1.AdmonitionsSchema.default(exports.DEFAULT_OPTIONS.admonitions),
@@ -44,4 +47,3 @@ function validateOptions({ validate, options, }) {
     const validatedOptions = validate(PluginOptionSchema, options);
     return validatedOptions;
 }
-exports.validateOptions = validateOptions;

package/lib/routes.d.ts

@@ -4,7 +4,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-/// <reference path="../src/plugin-content-pages.d.ts" />
 import type { PluginContentLoadedActions, RouteConfig } from '@docusaurus/types';
 import type { PluginOptions, LoadedContent } from '@docusaurus/plugin-content-pages';
 type CreateAllRoutesParam = {

package/lib/routes.js

@@ -6,7 +6,8 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildAllRoutes = exports.createAllRoutes = void 0;
+exports.createAllRoutes = createAllRoutes;
+exports.buildAllRoutes = buildAllRoutes;
 const utils_1 = require("@docusaurus/utils");
 function createPageRouteMetadata(metadata) {
     const lastUpdatedAt = metadata.type === 'mdx' ? metadata.lastUpdatedAt : undefined;
@@ -19,7 +20,6 @@ async function createAllRoutes(param) {
     const routes = await buildAllRoutes(param);
     routes.forEach(param.actions.addRoute);
 }
-exports.createAllRoutes = createAllRoutes;
 async function buildAllRoutes({ content, actions, options, }) {
     const { createData } = actions;
     async function buildMDXPageRoute(metadata) {
@@ -55,4 +55,3 @@ async function buildAllRoutes({ content, actions, options, }) {
     }
     return Promise.all(content.map(buildPageRoute));
 }
-exports.buildAllRoutes = buildAllRoutes;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-pages",
-  "version": "3.3.2",
+  "version": "3.5.0",
   "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.3.2",
-    "@docusaurus/mdx-loader": "3.3.2",
-    "@docusaurus/types": "3.3.2",
-    "@docusaurus/utils": "3.3.2",
-    "@docusaurus/utils-validation": "3.3.2",
+    "@docusaurus/core": "3.5.0",
+    "@docusaurus/mdx-loader": "3.5.0",
+    "@docusaurus/types": "3.5.0",
+    "@docusaurus/utils": "3.5.0",
+    "@docusaurus/utils-validation": "3.5.0",
     "fs-extra": "^11.1.1",
     "tslib": "^2.6.0",
     "webpack": "^5.88.1"
@@ -34,5 +34,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "bc638d674bfbde1e254ef306697f47e764b5e107"
+  "gitHead": "cb5829f3c34b26d798b869e38ee25073488140bd"
 }

package/src/index.ts

@@ -26,6 +26,8 @@ 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';
 
 export default function pluginContentPages(
   context: LoadContext,
@@ -70,10 +72,48 @@ export default function pluginContentPages(
         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: [
@@ -82,52 +122,7 @@ export default function pluginContentPages(
               include: contentDirs
                 // Trailing slash is important, see https://github.com/facebook/docusaurus/pull/3970
                 .map(addTrailingPathSeparator),
-              use: [
-                {
-                  loader: require.resolve('@docusaurus/mdx-loader'),
-                  options: {
-                    admonitions,
-                    remarkPlugins,
-                    rehypePlugins,
-                    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,
-                  },
-                },
-                {
-                  loader: path.resolve(__dirname, './markdownLoader.js'),
-                  options: {
-                    // siteDir,
-                    // contentPath,
-                  },
-                },
-              ].filter(Boolean),
+              use: [createMDXLoader()],
             },
           ],
         },

package/src/options.ts

@@ -9,6 +9,7 @@ import {
   Joi,
   RemarkPluginsSchema,
   RehypePluginsSchema,
+  RecmaPluginsSchema,
   AdmonitionsSchema,
   RouteBasePathSchema,
   URISchema,
@@ -25,6 +26,7 @@ export const DEFAULT_OPTIONS: PluginOptions = {
   mdxPageComponent: '@theme/MDXPage',
   remarkPlugins: [],
   rehypePlugins: [],
+  recmaPlugins: [],
   beforeDefaultRehypePlugins: [],
   beforeDefaultRemarkPlugins: [],
   admonitions: true,
@@ -41,6 +43,7 @@ const PluginOptionSchema = Joi.object<PluginOptions>({
   mdxPageComponent: Joi.string().default(DEFAULT_OPTIONS.mdxPageComponent),
   remarkPlugins: RemarkPluginsSchema.default(DEFAULT_OPTIONS.remarkPlugins),
   rehypePlugins: RehypePluginsSchema.default(DEFAULT_OPTIONS.rehypePlugins),
+  recmaPlugins: RecmaPluginsSchema.default(DEFAULT_OPTIONS.recmaPlugins),
   beforeDefaultRehypePlugins: RehypePluginsSchema.default(
     DEFAULT_OPTIONS.beforeDefaultRehypePlugins,
   ),

package/lib/markdownLoader.d.ts

@@ -1,8 +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 { LoaderContext } from 'webpack';
-export default function markdownLoader(this: LoaderContext<undefined>, fileString: string): void;

package/lib/markdownLoader.js

@@ -1,16 +0,0 @@
-"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 });
-function markdownLoader(fileString) {
-    const callback = this.async();
-    // const options = this.getOptions();
-    // TODO provide additional md processing here? like interlinking pages?
-    // fileString = linkify(fileString)
-    return callback(null, fileString);
-}
-exports.default = markdownLoader;

package/src/markdownLoader.ts

@@ -1,22 +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 {LoaderContext} from 'webpack';
-
-export default function markdownLoader(
-  this: LoaderContext<undefined>,
-  fileString: string,
-): void {
-  const callback = this.async();
-
-  // const options = this.getOptions();
-
-  // TODO provide additional md processing here? like interlinking pages?
-  // fileString = linkify(fileString)
-
-  return callback(null, fileString);
-}