@docusaurus/plugin-content-docs 3.8.1-canary-6361 → 3.8.1-canary-6364

package/lib/cli.js

@@ -49,7 +49,7 @@ async function cliDocsVersionCommand(version, { id: pluginId, path: docsPath, si
         logger_1.default.info `Versioned docs will be created for the following locales: name=${i18n.locales}`;
     }
     await Promise.all(i18n.locales.map(async (locale) => {
-        const localizationDir = path_1.default.resolve(siteDir, i18n.path, i18n.localeConfigs[locale].path);
+        const localizationDir = path_1.default.resolve(siteDir, i18n.path, (0, utils_1.getLocaleConfig)(i18n, locale).path);
         // Copy docs files.
         const docsDir = locale === i18n.defaultLocale
             ? path_1.default.resolve(siteDir, docsPath)

package/lib/docs.js

@@ -103,7 +103,8 @@ async function doProcessDocMetadata({ docFile, versionMetadata, context, options
             });
         }
         else if (typeof options.editUrl === 'string') {
-            const isLocalized = contentPath === versionMetadata.contentPathLocalized;
+            const isLocalized = typeof versionMetadata.contentPathLocalized !== 'undefined' &&
+                contentPath === versionMetadata.contentPathLocalized;
             const baseVersionEditUrl = isLocalized && options.editLocalizedFiles
                 ? versionMetadata.editUrlLocalized
                 : versionMetadata.editUrl;

package/lib/versions/files.js

@@ -117,11 +117,14 @@ async function readVersionNames(siteDir, options) {
  */
 async function getVersionMetadataPaths({ versionName, context, options, }) {
     const isCurrent = versionName === constants_1.CURRENT_VERSION_NAME;
-    const contentPathLocalized = getDocsDirPathLocalized({
-        localizationDir: context.localizationDir,
-        pluginId: options.id,
-        versionName,
-    });
+    const shouldTranslate = (0, utils_1.getLocaleConfig)(context.i18n).translate;
+    const contentPathLocalized = shouldTranslate
+        ? getDocsDirPathLocalized({
+            localizationDir: context.localizationDir,
+            pluginId: options.id,
+            versionName,
+        })
+        : undefined;
     const contentPath = isCurrent
         ? path_1.default.resolve(context.siteDir, options.path)
         : getVersionDocsDirPath(context.siteDir, options.id, versionName);

package/lib/versions/version.js

@@ -28,22 +28,32 @@ function getVersionEditUrls({ contentPath, contentPathLocalized, context, option
     if (!options.editUrl || typeof options.editUrl === 'function') {
         return { editUrl: undefined, editUrlLocalized: undefined };
     }
-    const editDirPath = options.editCurrentVersion ? options.path : contentPath;
-    const editDirPathLocalized = options.editCurrentVersion
-        ? (0, files_1.getDocsDirPathLocalized)({
-            localizationDir: context.localizationDir,
-            versionName: constants_1.CURRENT_VERSION_NAME,
-            pluginId: options.id,
-        })
-        : contentPathLocalized;
-    const versionPathSegment = (0, utils_1.posixPath)(path_1.default.relative(context.siteDir, path_1.default.resolve(context.siteDir, editDirPath)));
-    const versionPathSegmentLocalized = (0, utils_1.posixPath)(path_1.default.relative(context.siteDir, path_1.default.resolve(context.siteDir, editDirPathLocalized)));
-    const editUrl = (0, utils_1.normalizeUrl)([options.editUrl, versionPathSegment]);
-    const editUrlLocalized = (0, utils_1.normalizeUrl)([
-        options.editUrl,
-        versionPathSegmentLocalized,
-    ]);
-    return { editUrl, editUrlLocalized };
+    // Intermediate var just to please TS not narrowing to "string"
+    const editUrlOption = options.editUrl;
+    const getEditUrl = () => {
+        const editDirPath = options.editCurrentVersion ? options.path : contentPath;
+        return (0, utils_1.normalizeUrl)([
+            editUrlOption,
+            (0, utils_1.posixPath)(path_1.default.relative(context.siteDir, path_1.default.resolve(context.siteDir, editDirPath))),
+        ]);
+    };
+    const getEditUrlLocalized = () => {
+        if (!contentPathLocalized) {
+            return undefined;
+        }
+        const editDirPathLocalized = options.editCurrentVersion
+            ? (0, files_1.getDocsDirPathLocalized)({
+                localizationDir: context.localizationDir,
+                versionName: constants_1.CURRENT_VERSION_NAME,
+                pluginId: options.id,
+            })
+            : contentPathLocalized;
+        return (0, utils_1.normalizeUrl)([
+            editUrlOption,
+            (0, utils_1.posixPath)(path_1.default.relative(context.siteDir, path_1.default.resolve(context.siteDir, editDirPathLocalized))),
+        ]);
+    };
+    return { editUrl: getEditUrl(), editUrlLocalized: getEditUrlLocalized() };
 }
 /**
  * The default version banner depends on the version's relative position to the

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "3.8.1-canary-6361",
+  "version": "3.8.1-canary-6364",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "sideEffects": false,
@@ -35,15 +35,15 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "3.8.1-canary-6361",
-    "@docusaurus/logger": "3.8.1-canary-6361",
-    "@docusaurus/mdx-loader": "3.8.1-canary-6361",
-    "@docusaurus/module-type-aliases": "3.8.1-canary-6361",
-    "@docusaurus/theme-common": "3.8.1-canary-6361",
-    "@docusaurus/types": "3.8.1-canary-6361",
-    "@docusaurus/utils": "3.8.1-canary-6361",
-    "@docusaurus/utils-common": "3.8.1-canary-6361",
-    "@docusaurus/utils-validation": "3.8.1-canary-6361",
+    "@docusaurus/core": "3.8.1-canary-6364",
+    "@docusaurus/logger": "3.8.1-canary-6364",
+    "@docusaurus/mdx-loader": "3.8.1-canary-6364",
+    "@docusaurus/module-type-aliases": "3.8.1-canary-6364",
+    "@docusaurus/theme-common": "3.8.1-canary-6364",
+    "@docusaurus/types": "3.8.1-canary-6364",
+    "@docusaurus/utils": "3.8.1-canary-6364",
+    "@docusaurus/utils-common": "3.8.1-canary-6364",
+    "@docusaurus/utils-validation": "3.8.1-canary-6364",
     "@types/react-router-config": "^5.0.7",
     "combine-promises": "^1.1.0",
     "fs-extra": "^11.1.1",
@@ -67,5 +67,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "184f214bf6cf8502921c316289df34500fb9ebb7"
+  "gitHead": "eb21e3eaf84009a29feff55780bb5d3a76658d01"
 }

package/src/cli.ts

@@ -8,7 +8,7 @@
 import fs from 'fs-extra';
 import path from 'path';
 import logger from '@docusaurus/logger';
-import {DEFAULT_PLUGIN_ID} from '@docusaurus/utils';
+import {DEFAULT_PLUGIN_ID, getLocaleConfig} from '@docusaurus/utils';
 import {
   getVersionsFilePath,
   getVersionDocsDirPath,
@@ -89,7 +89,7 @@ async function cliDocsVersionCommand(
       const localizationDir = path.resolve(
         siteDir,
         i18n.path,
-        i18n.localeConfigs[locale]!.path,
+        getLocaleConfig(i18n, locale).path,
       );
       // Copy docs files.
       const docsDir =

package/src/docs.ts

@@ -196,7 +196,9 @@ async function doProcessDocMetadata({
         locale: context.i18n.currentLocale,
       });
     } else if (typeof options.editUrl === 'string') {
-      const isLocalized = contentPath === versionMetadata.contentPathLocalized;
+      const isLocalized =
+        typeof versionMetadata.contentPathLocalized !== 'undefined' &&
+        contentPath === versionMetadata.contentPathLocalized;
       const baseVersionEditUrl =
         isLocalized && options.editLocalizedFiles
           ? versionMetadata.editUrlLocalized

package/src/versions/files.ts

@@ -7,7 +7,11 @@
 
 import path from 'path';
 import fs from 'fs-extra';
-import {getPluginI18nPath, DEFAULT_PLUGIN_ID} from '@docusaurus/utils';
+import {
+  getPluginI18nPath,
+  getLocaleConfig,
+  DEFAULT_PLUGIN_ID,
+} from '@docusaurus/utils';
 import {
   VERSIONS_JSON_FILE,
   VERSIONED_DOCS_DIR,
@@ -186,11 +190,16 @@ export async function getVersionMetadataPaths({
   >
 > {
   const isCurrent = versionName === CURRENT_VERSION_NAME;
-  const contentPathLocalized = getDocsDirPathLocalized({
-    localizationDir: context.localizationDir,
-    pluginId: options.id,
-    versionName,
-  });
+
+  const shouldTranslate = getLocaleConfig(context.i18n).translate;
+  const contentPathLocalized = shouldTranslate
+    ? getDocsDirPathLocalized({
+        localizationDir: context.localizationDir,
+        pluginId: options.id,
+        versionName,
+      })
+    : undefined;
+
   const contentPath = isCurrent
     ? path.resolve(context.siteDir, options.path)
     : getVersionDocsDirPath(context.siteDir, options.id, versionName);

package/src/versions/version.ts

@@ -50,33 +50,47 @@ function getVersionEditUrls({
     return {editUrl: undefined, editUrlLocalized: undefined};
   }
 
-  const editDirPath = options.editCurrentVersion ? options.path : contentPath;
-  const editDirPathLocalized = options.editCurrentVersion
-    ? getDocsDirPathLocalized({
-        localizationDir: context.localizationDir,
-        versionName: CURRENT_VERSION_NAME,
-        pluginId: options.id,
-      })
-    : contentPathLocalized;
+  // Intermediate var just to please TS not narrowing to "string"
+  const editUrlOption = options.editUrl;
 
-  const versionPathSegment = posixPath(
-    path.relative(context.siteDir, path.resolve(context.siteDir, editDirPath)),
-  );
-  const versionPathSegmentLocalized = posixPath(
-    path.relative(
-      context.siteDir,
-      path.resolve(context.siteDir, editDirPathLocalized),
-    ),
-  );
+  const getEditUrl = () => {
+    const editDirPath = options.editCurrentVersion ? options.path : contentPath;
+
+    return normalizeUrl([
+      editUrlOption,
+      posixPath(
+        path.relative(
+          context.siteDir,
+          path.resolve(context.siteDir, editDirPath),
+        ),
+      ),
+    ]);
+  };
 
-  const editUrl = normalizeUrl([options.editUrl, versionPathSegment]);
+  const getEditUrlLocalized = () => {
+    if (!contentPathLocalized) {
+      return undefined;
+    }
+    const editDirPathLocalized = options.editCurrentVersion
+      ? getDocsDirPathLocalized({
+          localizationDir: context.localizationDir,
+          versionName: CURRENT_VERSION_NAME,
+          pluginId: options.id,
+        })
+      : contentPathLocalized;
 
-  const editUrlLocalized = normalizeUrl([
-    options.editUrl,
-    versionPathSegmentLocalized,
-  ]);
+    return normalizeUrl([
+      editUrlOption,
+      posixPath(
+        path.relative(
+          context.siteDir,
+          path.resolve(context.siteDir, editDirPathLocalized),
+        ),
+      ),
+    ]);
+  };
 
-  return {editUrl, editUrlLocalized};
+  return {editUrl: getEditUrl(), editUrlLocalized: getEditUrlLocalized()};
 }
 
 /**