@docusaurus/plugin-content-pages 3.9.2 → 3.10.0

package/lib/content.js

@@ -49,6 +49,7 @@ async function loadPagesContent(params) {
 async function processPageSourceFile(relativeSource, params) {
     const { context, options, contentPaths } = params;
     const { siteConfig, baseUrl, siteDir, i18n } = context;
+    const vcs = siteConfig.future.experimental_vcs;
     const { editUrl } = options;
     // Lookup in localized folder in priority
     const contentPath = await (0, utils_1.getFolderContainingFile)((0, utils_1.getContentPathList)(contentPaths), relativeSource);
@@ -101,7 +102,7 @@ async function processPageSourceFile(relativeSource, params) {
         }
         return undefined;
     }
-    const lastUpdatedData = await (0, utils_1.readLastUpdateData)(source, options, frontMatter.last_update);
+    const lastUpdatedData = await (0, utils_1.readLastUpdateData)(source, options, frontMatter.last_update, vcs);
     if ((0, utils_1.isDraft)({ frontMatter })) {
         return undefined;
     }

package/lib/contentHelpers.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 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 { LoadedContent, Metadata } from '@docusaurus/plugin-content-pages';
+export declare function createContentHelpers(): {
+    updateContent: (content: LoadedContent) => void;
+    sourceToPage: Map<string, Metadata>;
+    sourceToPermalink: Map<string, string>;
+};

package/lib/contentHelpers.js

@@ -0,0 +1,30 @@
+"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.createContentHelpers = createContentHelpers;
+function indexPagesBySource(content) {
+    return new Map(content.map((page) => [page.source, page]));
+}
+// TODO this is bad, we should have a better way to do this (new lifecycle?)
+//  The source to page/permalink is a mutable map passed to the mdx loader
+//  See https://github.com/facebook/docusaurus/pull/10457
+//  See https://github.com/facebook/docusaurus/pull/10185
+function createContentHelpers() {
+    const sourceToPage = new Map();
+    const sourceToPermalink = new Map();
+    // Mutable map update :/
+    function updateContent(content) {
+        sourceToPage.clear();
+        sourceToPermalink.clear();
+        indexPagesBySource(content).forEach((value, key) => {
+            sourceToPage.set(key, value);
+            sourceToPermalink.set(key, value.permalink);
+        });
+    }
+    return { updateContent, sourceToPage, sourceToPermalink };
+}

package/lib/index.js

@@ -15,11 +15,13 @@ const utils_1 = require("@docusaurus/utils");
 const mdx_loader_1 = require("@docusaurus/mdx-loader");
 const routes_1 = require("./routes");
 const content_1 = require("./content");
+const contentHelpers_1 = require("./contentHelpers");
 async function pluginContentPages(context, options) {
     const { siteConfig, siteDir, generatedFilesDir } = context;
     const contentPaths = (0, content_1.createPagesContentPaths)({ context, options });
+    const contentHelpers = (0, contentHelpers_1.createContentHelpers)();
     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);
+    const dataDir = path_1.default.join(pluginDataDirRoot, options.id);
     async function createPagesMDXLoaderRule() {
         const { admonitions, rehypePlugins, remarkPlugins, recmaPlugins, beforeDefaultRehypePlugins, beforeDefaultRemarkPlugins, } = options;
         const contentDirs = (0, utils_1.getContentPathList)(contentPaths);
@@ -28,7 +30,7 @@ async function pluginContentPages(context, options) {
                 // Trailing slash is important, see https://github.com/facebook/docusaurus/pull/3970
                 .map(utils_1.addTrailingPathSeparator),
             options: {
-                useCrossCompilerCache: siteConfig.future.experimental_faster.mdxCrossCompilerCache,
+                useCrossCompilerCache: siteConfig.future.faster.mdxCrossCompilerCache,
                 admonitions,
                 remarkPlugins,
                 rehypePlugins,
@@ -49,6 +51,14 @@ async function pluginContentPages(context, options) {
                     image: frontMatter.image,
                 }),
                 markdownConfig: siteConfig.markdown,
+                resolveMarkdownLink: ({ linkPathname, sourceFilePath }) => {
+                    return (0, utils_1.resolveMarkdownLinkPathname)(linkPathname, {
+                        sourceFilePath,
+                        sourceToPermalink: contentHelpers.sourceToPermalink,
+                        siteDir,
+                        contentPaths,
+                    });
+                },
             },
         });
     }
@@ -69,6 +79,7 @@ async function pluginContentPages(context, options) {
             if (!content) {
                 return;
             }
+            contentHelpers.updateContent(content);
             await (0, routes_1.createAllRoutes)({ content, options, actions });
         },
         configureWebpack() {

package/lib/options.js

@@ -11,6 +11,7 @@ exports.validateOptions = validateOptions;
 const utils_validation_1 = require("@docusaurus/utils-validation");
 const utils_1 = require("@docusaurus/utils");
 exports.DEFAULT_OPTIONS = {
+    id: utils_1.DEFAULT_PLUGIN_ID,
     path: 'src/pages', // Path to data on filesystem, relative to site dir.
     routeBasePath: '/', // URL Route.
     include: ['**/*.{js,jsx,ts,tsx,md,mdx}'], // Extensions to include.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-pages",
-  "version": "3.9.2",
+  "version": "3.10.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.9.2",
-    "@docusaurus/mdx-loader": "3.9.2",
-    "@docusaurus/types": "3.9.2",
-    "@docusaurus/utils": "3.9.2",
-    "@docusaurus/utils-validation": "3.9.2",
+    "@docusaurus/core": "3.10.0",
+    "@docusaurus/mdx-loader": "3.10.0",
+    "@docusaurus/types": "3.10.0",
+    "@docusaurus/utils": "3.10.0",
+    "@docusaurus/utils-validation": "3.10.0",
     "fs-extra": "^11.1.1",
     "tslib": "^2.6.0",
     "webpack": "^5.88.1"
@@ -34,5 +34,5 @@
   "engines": {
     "node": ">=20.0"
   },
-  "gitHead": "abfbe5621b08407bc3dcbe6111ff118d4c22f7a1"
+  "gitHead": "0d98888a7645a5fb1330c905b75faf868f829f5c"
 }

package/src/content.ts

@@ -98,6 +98,7 @@ async function processPageSourceFile(
 ): Promise<Metadata | undefined> {
   const {context, options, contentPaths} = params;
   const {siteConfig, baseUrl, siteDir, i18n} = context;
+  const vcs = siteConfig.future.experimental_vcs;
   const {editUrl} = options;
 
   // Lookup in localized folder in priority
@@ -180,6 +181,7 @@ async function processPageSourceFile(
     source,
     options,
     frontMatter.last_update,
+    vcs,
   );
 
   if (isDraft({frontMatter})) {

package/src/contentHelpers.ts

@@ -0,0 +1,33 @@
+/**
+ * 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 {LoadedContent, Metadata} from '@docusaurus/plugin-content-pages';
+
+function indexPagesBySource(content: LoadedContent): Map<string, Metadata> {
+  return new Map(content.map((page) => [page.source, page]));
+}
+
+// TODO this is bad, we should have a better way to do this (new lifecycle?)
+//  The source to page/permalink is a mutable map passed to the mdx loader
+//  See https://github.com/facebook/docusaurus/pull/10457
+//  See https://github.com/facebook/docusaurus/pull/10185
+export function createContentHelpers() {
+  const sourceToPage = new Map<string, Metadata>();
+  const sourceToPermalink = new Map<string, string>();
+
+  // Mutable map update :/
+  function updateContent(content: LoadedContent): void {
+    sourceToPage.clear();
+    sourceToPermalink.clear();
+    indexPagesBySource(content).forEach((value, key) => {
+      sourceToPage.set(key, value);
+      sourceToPermalink.set(key, value.permalink);
+    });
+  }
+
+  return {updateContent, sourceToPage, sourceToPermalink};
+}

package/src/index.ts

@@ -13,11 +13,12 @@ import {
   addTrailingPathSeparator,
   createAbsoluteFilePathMatcher,
   getContentPathList,
-  DEFAULT_PLUGIN_ID,
+  resolveMarkdownLinkPathname,
 } from '@docusaurus/utils';
 import {createMDXLoaderRule} from '@docusaurus/mdx-loader';
 import {createAllRoutes} from './routes';
 import {createPagesContentPaths, loadPagesContent} from './content';
+import {createContentHelpers} from './contentHelpers';
 import type {LoadContext, Plugin} from '@docusaurus/types';
 import type {
   PluginOptions,
@@ -33,12 +34,13 @@ export default async function pluginContentPages(
   const {siteConfig, siteDir, generatedFilesDir} = context;
 
   const contentPaths = createPagesContentPaths({context, options});
+  const contentHelpers = createContentHelpers();
 
   const pluginDataDirRoot = path.join(
     generatedFilesDir,
     'docusaurus-plugin-content-pages',
   );
-  const dataDir = path.join(pluginDataDirRoot, options.id ?? DEFAULT_PLUGIN_ID);
+  const dataDir = path.join(pluginDataDirRoot, options.id);
 
   async function createPagesMDXLoaderRule(): Promise<RuleSetRule> {
     const {
@@ -56,8 +58,7 @@ export default async function pluginContentPages(
         // Trailing slash is important, see https://github.com/facebook/docusaurus/pull/3970
         .map(addTrailingPathSeparator),
       options: {
-        useCrossCompilerCache:
-          siteConfig.future.experimental_faster.mdxCrossCompilerCache,
+        useCrossCompilerCache: siteConfig.future.faster.mdxCrossCompilerCache,
         admonitions,
         remarkPlugins,
         rehypePlugins,
@@ -83,6 +84,14 @@ export default async function pluginContentPages(
           image: frontMatter.image,
         }),
         markdownConfig: siteConfig.markdown,
+        resolveMarkdownLink: ({linkPathname, sourceFilePath}) => {
+          return resolveMarkdownLinkPathname(linkPathname, {
+            sourceFilePath,
+            sourceToPermalink: contentHelpers.sourceToPermalink,
+            siteDir,
+            contentPaths,
+          });
+        },
       },
     });
   }
@@ -110,6 +119,7 @@ export default async function pluginContentPages(
       if (!content) {
         return;
       }
+      contentHelpers.updateContent(content);
       await createAllRoutes({content, options, actions});
     },
 

package/src/options.ts

@@ -14,11 +14,12 @@ import {
   RouteBasePathSchema,
   URISchema,
 } from '@docusaurus/utils-validation';
-import {GlobExcludeDefault} from '@docusaurus/utils';
+import {DEFAULT_PLUGIN_ID, GlobExcludeDefault} from '@docusaurus/utils';
 import type {OptionValidationContext} from '@docusaurus/types';
 import type {PluginOptions, Options} from '@docusaurus/plugin-content-pages';
 
 export const DEFAULT_OPTIONS: PluginOptions = {
+  id: DEFAULT_PLUGIN_ID,
   path: 'src/pages', // Path to data on filesystem, relative to site dir.
   routeBasePath: '/', // URL Route.
   include: ['**/*.{js,jsx,ts,tsx,md,mdx}'], // Extensions to include.

package/src/plugin-content-pages.d.ts

@@ -19,7 +19,7 @@ declare module '@docusaurus/plugin-content-pages' {
   };
 
   export type PluginOptions = MDXOptions & {
-    id?: string;
+    id: string;
     path: string;
     routeBasePath: string;
     include: string[];