@docusaurus/plugin-content-pages 3.8.1 → 3.9.0-canary-6406

package/lib/content.d.ts

@@ -4,18 +4,17 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+import { type ContentPaths } from '@docusaurus/utils';
 import type { LoadContext } from '@docusaurus/types';
-import type { PagesContentPaths } from './types';
 import type { PluginOptions, LoadedContent } from '@docusaurus/plugin-content-pages';
 export declare function createPagesContentPaths({ context, options, }: {
     context: LoadContext;
     options: PluginOptions;
-}): PagesContentPaths;
-export declare function getContentPathList(contentPaths: PagesContentPaths): string[];
+}): ContentPaths;
 type LoadContentParams = {
     context: LoadContext;
     options: PluginOptions;
-    contentPaths: PagesContentPaths;
+    contentPaths: ContentPaths;
 };
 export declare function loadPagesContent(params: LoadContentParams): Promise<LoadedContent>;
 export {};

package/lib/content.js

@@ -7,7 +7,6 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createPagesContentPaths = createPagesContentPaths;
-exports.getContentPathList = getContentPathList;
 exports.loadPagesContent = loadPagesContent;
 const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
@@ -16,18 +15,18 @@ const utils_1 = require("@docusaurus/utils");
 const frontMatter_1 = require("./frontMatter");
 function createPagesContentPaths({ context, options, }) {
     const { siteDir, localizationDir } = context;
+    const shouldTranslate = (0, utils_1.getLocaleConfig)(context.i18n).translate;
     return {
         contentPath: path_1.default.resolve(siteDir, options.path),
-        contentPathLocalized: (0, utils_1.getPluginI18nPath)({
-            localizationDir,
-            pluginName: 'docusaurus-plugin-content-pages',
-            pluginId: options.id,
-        }),
+        contentPathLocalized: shouldTranslate
+            ? (0, utils_1.getPluginI18nPath)({
+                localizationDir,
+                pluginName: 'docusaurus-plugin-content-pages',
+                pluginId: options.id,
+            })
+            : undefined,
     };
 }
-function getContentPathList(contentPaths) {
-    return [contentPaths.contentPathLocalized, contentPaths.contentPath];
-}
 const isMarkdownSource = (source) => source.endsWith('.md') || source.endsWith('.mdx');
 async function loadPagesContent(params) {
     const { options } = params;
@@ -52,7 +51,7 @@ async function processPageSourceFile(relativeSource, params) {
     const { siteConfig, baseUrl, siteDir, i18n } = context;
     const { editUrl } = options;
     // Lookup in localized folder in priority
-    const contentPath = await (0, utils_1.getFolderContainingFile)(getContentPathList(contentPaths), relativeSource);
+    const contentPath = await (0, utils_1.getFolderContainingFile)((0, utils_1.getContentPathList)(contentPaths), relativeSource);
     const source = path_1.default.join(contentPath, relativeSource);
     const aliasedSourcePath = (0, utils_1.aliasedSitePath)(source, siteDir);
     const filenameSlug = (0, utils_1.encodePath)((0, utils_1.fileToPath)(relativeSource));
@@ -75,7 +74,7 @@ async function processPageSourceFile(relativeSource, params) {
     const frontMatter = (0, frontMatter_1.validatePageFrontMatter)(unsafeFrontMatter);
     const slug = frontMatter.slug ?? filenameSlug;
     const permalink = (0, utils_1.normalizeUrl)([baseUrl, options.routeBasePath, slug]);
-    const pagesDirPath = await (0, utils_1.getFolderContainingFile)(getContentPathList(contentPaths), relativeSource);
+    const pagesDirPath = await (0, utils_1.getFolderContainingFile)((0, utils_1.getContentPathList)(contentPaths), relativeSource);
     const pagesSourceAbsolute = path_1.default.join(pagesDirPath, relativeSource);
     function getPagesEditUrl() {
         const pagesPathRelative = path_1.default.relative(pagesDirPath, path_1.default.resolve(pagesSourceAbsolute));
@@ -89,7 +88,9 @@ async function processPageSourceFile(relativeSource, params) {
         }
         else if (typeof editUrl === 'string') {
             const isLocalized = pagesDirPath === contentPaths.contentPathLocalized;
-            const fileContentPath = isLocalized && options.editLocalizedFiles
+            const fileContentPath = isLocalized &&
+                options.editLocalizedFiles &&
+                contentPaths.contentPathLocalized
                 ? contentPaths.contentPathLocalized
                 : contentPaths.contentPath;
             const contentPathEditUrl = (0, utils_1.normalizeUrl)([

package/lib/index.js

@@ -22,7 +22,7 @@ async function pluginContentPages(context, options) {
     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);
+        const contentDirs = (0, utils_1.getContentPathList)(contentPaths);
         return (0, mdx_loader_1.createMDXLoaderRule)({
             include: contentDirs
                 // Trailing slash is important, see https://github.com/facebook/docusaurus/pull/3970
@@ -57,7 +57,7 @@ async function pluginContentPages(context, options) {
         name: 'docusaurus-plugin-content-pages',
         getPathsToWatch() {
             const { include } = options;
-            return (0, content_1.getContentPathList)(contentPaths).flatMap((contentPath) => include.map((pattern) => `${contentPath}/${pattern}`));
+            return (0, utils_1.getContentPathList)(contentPaths).flatMap((contentPath) => include.map((pattern) => `${contentPath}/${pattern}`));
         },
         async loadContent() {
             if (!(await fs_extra_1.default.pathExists(contentPaths.contentPath))) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-pages",
-  "version": "3.8.1",
+  "version": "3.9.0-canary-6406",
   "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.8.1",
-    "@docusaurus/mdx-loader": "3.8.1",
-    "@docusaurus/types": "3.8.1",
-    "@docusaurus/utils": "3.8.1",
-    "@docusaurus/utils-validation": "3.8.1",
+    "@docusaurus/core": "3.9.0-canary-6406",
+    "@docusaurus/mdx-loader": "3.9.0-canary-6406",
+    "@docusaurus/types": "3.9.0-canary-6406",
+    "@docusaurus/utils": "3.9.0-canary-6406",
+    "@docusaurus/utils-validation": "3.9.0-canary-6406",
     "fs-extra": "^11.1.1",
     "tslib": "^2.6.0",
     "webpack": "^5.88.1"
@@ -32,7 +32,7 @@
     "react-dom": "^18.0.0 || ^19.0.0"
   },
   "engines": {
-    "node": ">=18.0"
+    "node": ">=20.0"
   },
-  "gitHead": "fa8ae13e668fcbc0481ce10c0a734e2a5b397293"
+  "gitHead": "796441f4f831278ffc57971fabcd4c730da9e9d7"
 }

package/src/content.ts

@@ -21,10 +21,12 @@ import {
   getEditUrl,
   posixPath,
   getPluginI18nPath,
+  getContentPathList,
+  getLocaleConfig,
+  type ContentPaths,
 } from '@docusaurus/utils';
 import {validatePageFrontMatter} from './frontMatter';
 import type {LoadContext} from '@docusaurus/types';
-import type {PagesContentPaths} from './types';
 import type {
   PluginOptions,
   Metadata,
@@ -37,29 +39,29 @@ export function createPagesContentPaths({
 }: {
   context: LoadContext;
   options: PluginOptions;
-}): PagesContentPaths {
+}): ContentPaths {
   const {siteDir, localizationDir} = context;
+
+  const shouldTranslate = getLocaleConfig(context.i18n).translate;
   return {
     contentPath: path.resolve(siteDir, options.path),
-    contentPathLocalized: getPluginI18nPath({
-      localizationDir,
-      pluginName: 'docusaurus-plugin-content-pages',
-      pluginId: options.id,
-    }),
+    contentPathLocalized: shouldTranslate
+      ? getPluginI18nPath({
+          localizationDir,
+          pluginName: 'docusaurus-plugin-content-pages',
+          pluginId: options.id,
+        })
+      : undefined,
   };
 }
 
-export function getContentPathList(contentPaths: PagesContentPaths): string[] {
-  return [contentPaths.contentPathLocalized, contentPaths.contentPath];
-}
-
 const isMarkdownSource = (source: string) =>
   source.endsWith('.md') || source.endsWith('.mdx');
 
 type LoadContentParams = {
   context: LoadContext;
   options: PluginOptions;
-  contentPaths: PagesContentPaths;
+  contentPaths: ContentPaths;
 };
 
 export async function loadPagesContent(
@@ -158,7 +160,9 @@ async function processPageSourceFile(
     } else if (typeof editUrl === 'string') {
       const isLocalized = pagesDirPath === contentPaths.contentPathLocalized;
       const fileContentPath =
-        isLocalized && options.editLocalizedFiles
+        isLocalized &&
+        options.editLocalizedFiles &&
+        contentPaths.contentPathLocalized
           ? contentPaths.contentPathLocalized
           : contentPaths.contentPath;
 

package/src/index.ts

@@ -12,15 +12,12 @@ import {
   docuHash,
   addTrailingPathSeparator,
   createAbsoluteFilePathMatcher,
+  getContentPathList,
   DEFAULT_PLUGIN_ID,
 } from '@docusaurus/utils';
 import {createMDXLoaderRule} from '@docusaurus/mdx-loader';
 import {createAllRoutes} from './routes';
-import {
-  createPagesContentPaths,
-  getContentPathList,
-  loadPagesContent,
-} from './content';
+import {createPagesContentPaths, loadPagesContent} from './content';
 import type {LoadContext, Plugin} from '@docusaurus/types';
 import type {
   PluginOptions,

package/lib/types.d.ts

@@ -1,10 +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.
- */
-export type PagesContentPaths = {
-    contentPath: string;
-    contentPathLocalized: string;
-};

package/lib/types.js

@@ -1,8 +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 });

package/src/types.ts

@@ -1,11 +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.
- */
-
-export type PagesContentPaths = {
-  contentPath: string;
-  contentPathLocalized: string;
-};