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

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/index.js

@@ -11,7 +11,6 @@ exports.default = pluginContentDocs;
 const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
-const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const utils_1 = require("@docusaurus/utils");
 const utils_validation_1 = require("@docusaurus/utils-validation");
 const mdx_loader_1 = require("@docusaurus/mdx-loader");
@@ -30,6 +29,11 @@ const loadVersion_1 = require("./versions/loadVersion");
 // Problem documented here: https://github.com/facebook/docusaurus/pull/10934
 // TODO this is not a perfect solution, find better?
 async function createMdxLoaderDependencyFile({ dataDir, options, versionsMetadata, }) {
+    // Disabled for unit tests, the side effect produces infinite watch loops
+    // TODO find a better way :/
+    if (process.env.NODE_ENV === 'test') {
+        return undefined;
+    }
     const filePath = path_1.default.join(dataDir, '__mdx-loader-dependency.json');
     // the cache is invalidated whenever this file content changes
     const fileContent = {
@@ -94,16 +98,12 @@ async function pluginContentDocs(context, options) {
                 markdownConfig: siteConfig.markdown,
                 resolveMarkdownLink: ({ linkPathname, sourceFilePath }) => {
                     const version = (0, version_1.getVersionFromSourceFilePath)(sourceFilePath, versionsMetadata);
-                    const permalink = (0, utils_1.resolveMarkdownLinkPathname)(linkPathname, {
+                    return (0, utils_1.resolveMarkdownLinkPathname)(linkPathname, {
                         sourceFilePath,
                         sourceToPermalink: contentHelpers.sourceToPermalink,
                         siteDir,
                         contentPaths: version,
                     });
-                    if (permalink === null) {
-                        logger_1.default.report(siteConfig.onBrokenMarkdownLinks) `Docs markdown link couldn't be resolved: (url=${linkPathname}) in source file path=${sourceFilePath} for version number=${version.versionName}`;
-                    }
-                    return permalink;
                 },
             },
         });

package/lib/props.d.ts

@@ -11,7 +11,7 @@ export declare function toSidebarDocItemLinkProp({ item, doc, }: {
     item: SidebarItemDoc;
     doc: Pick<DocMetadata, 'id' | 'title' | 'permalink' | 'unlisted' | 'frontMatter'>;
 }): PropSidebarItemLink;
-export declare function toSidebarsProp(loadedVersion: LoadedVersion): PropSidebars;
+export declare function toSidebarsProp(loadedVersion: Pick<LoadedVersion, 'docs' | 'sidebars'>): PropSidebars;
 export declare function toVersionMetadataProp(pluginId: string, loadedVersion: LoadedVersion): PropVersionMetadata;
 export declare function toTagDocListProp({ allTagsPath, tag, docs, }: {
     allTagsPath: string;

package/lib/props.js

@@ -15,13 +15,15 @@ const tslib_1 = require("tslib");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const docs_1 = require("./docs");
 function toSidebarDocItemLinkProp({ item, doc, }) {
-    const { id, title, permalink, frontMatter: { sidebar_label: sidebarLabel, sidebar_custom_props: customProps, }, unlisted, } = doc;
+    const { id, title, permalink, frontMatter, unlisted } = doc;
     return {
         type: 'link',
-        label: sidebarLabel ?? item.label ?? title,
+        ...(item.key && { key: item.key }),
         href: permalink,
-        className: item.className,
-        customProps: item.customProps ?? customProps,
+        // Front Matter data takes precedence over sidebars.json
+        label: frontMatter.sidebar_label ?? item.label ?? title,
+        className: frontMatter.sidebar_class_name ?? item.className,
+        customProps: frontMatter.sidebar_custom_props ?? item.customProps,
         docId: id,
         unlisted,
     };

package/lib/sidebars/generator.js

@@ -171,6 +171,7 @@ Available doc IDs:
                 ...(categoryMetadata?.description && {
                     description: categoryMetadata?.description,
                 }),
+                ...(categoryMetadata?.key && { key: categoryMetadata?.key }),
                 ...(link && { link }),
             };
         }

package/lib/sidebars/postProcessor.js

@@ -53,10 +53,13 @@ function postProcessSidebarItem(item, params) {
                 params.draftIds.has(category.link.id)) {
                 return null;
             }
+            const { label, className, customProps } = category;
             return {
                 type: 'doc',
-                label: category.label,
                 id: category.link.id,
+                label,
+                ...(className && { className }),
+                ...(customProps && { customProps }),
             };
         }
         // A non-collapsible category can't be collapsed!

package/lib/sidebars/types.d.ts

@@ -13,6 +13,7 @@ type Expand<T extends {
     [P in keyof T]: T[P];
 };
 export type SidebarItemBase = {
+    key?: string;
     className?: string;
     customProps?: {
         [key: string]: unknown;
@@ -23,8 +24,9 @@ export type SidebarItemDoc = SidebarItemBase & {
     label?: string;
     id: string;
     /**
-     * This is an internal marker. Items with labels defined in the config needs
-     * to be translated with JSON
+     * This is an internal marker set during the sidebar normalization process.
+     * Docs with labels defined in the config need to be translated with JSON.
+     * Otherwise, it's preferable to translate the MDX doc title or front matter.
      */
     translatable?: true;
 };
@@ -136,6 +138,7 @@ export type PropSidebars = {
 };
 export type PropSidebarBreadcrumbsItem = PropSidebarItemLink | PropSidebarItemCategory;
 export type CategoryMetadataFile = {
+    key?: string;
     label?: string;
     position?: number;
     description?: string;

package/lib/sidebars/validation.js

@@ -13,6 +13,7 @@ const utils_validation_1 = require("@docusaurus/utils-validation");
 // Config types are exposed to users for typechecking and we use the same type
 // in normalization
 const sidebarItemBaseSchema = utils_validation_1.Joi.object({
+    key: utils_validation_1.Joi.string(),
     className: utils_validation_1.Joi.string(),
     customProps: utils_validation_1.Joi.object().unknown(),
 });
@@ -132,6 +133,7 @@ function validateSidebars(sidebars) {
     });
 }
 const categoryMetadataFileSchema = utils_validation_1.Joi.object({
+    key: utils_validation_1.Joi.string(),
     label: utils_validation_1.Joi.string(),
     description: utils_validation_1.Joi.string(),
     position: utils_validation_1.Joi.number(),

package/lib/translations.js

@@ -11,6 +11,7 @@ exports.translateLoadedContent = translateLoadedContent;
 const tslib_1 = require("tslib");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const utils_1 = require("@docusaurus/utils");
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const constants_1 = require("./constants");
 const utils_2 = require("./sidebars/utils");
 function getVersionFileName(versionName) {
@@ -21,12 +22,33 @@ function getVersionFileName(versionName) {
     // but it's for consistency with site/versioned_docs
     return `version-${versionName}`;
 }
+function ensureNoSidebarDuplicateEntries(translationEntries) {
+    const grouped = lodash_1.default.groupBy(translationEntries, (entry) => entry[0]);
+    const duplicates = Object.entries(grouped).filter((entry) => entry[1].length > 1);
+    if (duplicates.length > 0) {
+        throw new Error(`Multiple docs sidebar items produce the same translation key.
+- ${duplicates
+            .map(([translationKey, entries]) => {
+            return `${logger_1.default.code(translationKey)}: ${logger_1.default.num(entries.length)} duplicates found:\n  - ${entries
+                .map((duplicate) => {
+                const desc = duplicate[1].description;
+                return `${logger_1.default.name(duplicate[1].message)} ${desc ? `(${logger_1.default.subdue(desc)})` : ''}`;
+            })
+                .join('\n  - ')}`;
+        })
+            .join('\n\n- ')}
+
+To avoid translation key conflicts, use the ${logger_1.default.code('key')} attribute on the sidebar items above to uniquely identify them.
+    `);
+    }
+}
 function getSidebarTranslationFileContent(sidebar, sidebarName) {
     const categories = (0, utils_2.collectSidebarCategories)(sidebar);
-    const categoryContent = Object.fromEntries(categories.flatMap((category) => {
+    const categoryEntries = categories.flatMap((category) => {
         const entries = [];
+        const categoryKey = category.key ?? category.label;
         entries.push([
-            `sidebar.${sidebarName}.category.${category.label}`,
+            `sidebar.${sidebarName}.category.${categoryKey}`,
             {
                 message: category.label,
                 description: `The label for category ${category.label} in sidebar ${sidebarName}`,
@@ -35,7 +57,7 @@ function getSidebarTranslationFileContent(sidebar, sidebarName) {
         if (category.link?.type === 'generated-index') {
             if (category.link.title) {
                 entries.push([
-                    `sidebar.${sidebarName}.category.${category.label}.link.generated-index.title`,
+                    `sidebar.${sidebarName}.category.${categoryKey}.link.generated-index.title`,
                     {
                         message: category.link.title,
                         description: `The generated-index page title for category ${category.label} in sidebar ${sidebarName}`,
@@ -44,7 +66,7 @@ function getSidebarTranslationFileContent(sidebar, sidebarName) {
             }
             if (category.link.description) {
                 entries.push([
-                    `sidebar.${sidebarName}.category.${category.label}.link.generated-index.description`,
+                    `sidebar.${sidebarName}.category.${categoryKey}.link.generated-index.description`,
                     {
                         message: category.link.description,
                         description: `The generated-index page description for category ${category.label} in sidebar ${sidebarName}`,
@@ -53,26 +75,34 @@ function getSidebarTranslationFileContent(sidebar, sidebarName) {
             }
         }
         return entries;
-    }));
+    });
     const links = (0, utils_2.collectSidebarLinks)(sidebar);
-    const linksContent = Object.fromEntries(links.map((link) => [
-        `sidebar.${sidebarName}.link.${link.label}`,
-        {
-            message: link.label,
-            description: `The label for link ${link.label} in sidebar ${sidebarName}, linking to ${link.href}`,
-        },
-    ]));
+    const linksEntries = links.map((link) => {
+        const linkKey = link.key ?? link.label;
+        return [
+            `sidebar.${sidebarName}.link.${linkKey}`,
+            {
+                message: link.label,
+                description: `The label for link ${link.label} in sidebar ${sidebarName}, linking to ${link.href}`,
+            },
+        ];
+    });
     const docs = (0, utils_2.collectSidebarDocItems)(sidebar)
         .concat((0, utils_2.collectSidebarRefs)(sidebar))
         .filter((item) => item.translatable);
-    const docLinksContent = Object.fromEntries(docs.map((doc) => [
-        `sidebar.${sidebarName}.doc.${doc.label}`,
-        {
-            message: doc.label,
-            description: `The label for the doc item ${doc.label} in sidebar ${sidebarName}, linking to the doc ${doc.id}`,
-        },
-    ]));
-    return (0, utils_1.mergeTranslations)([categoryContent, linksContent, docLinksContent]);
+    const docLinksEntries = docs.map((doc) => {
+        const docKey = doc.key ?? doc.label;
+        return [
+            `sidebar.${sidebarName}.doc.${docKey}`,
+            {
+                message: doc.label,
+                description: `The label for the doc item ${doc.label} in sidebar ${sidebarName}, linking to the doc ${doc.id}`,
+            },
+        ];
+    });
+    const allEntries = [...categoryEntries, ...linksEntries, ...docLinksEntries];
+    ensureNoSidebarDuplicateEntries(allEntries);
+    return Object.fromEntries(allEntries);
 }
 function translateSidebar({ sidebar, sidebarName, sidebarsTranslations, }) {
     function transformSidebarCategoryLink(category) {
@@ -93,24 +123,27 @@ function translateSidebar({ sidebar, sidebarName, sidebarsTranslations, }) {
     return (0, utils_2.transformSidebarItems)(sidebar, (item) => {
         if (item.type === 'category') {
             const link = transformSidebarCategoryLink(item);
+            const categoryKey = item.key ?? item.label;
             return {
                 ...item,
-                label: sidebarsTranslations[`sidebar.${sidebarName}.category.${item.label}`]
+                label: sidebarsTranslations[`sidebar.${sidebarName}.category.${categoryKey}`]
                     ?.message ?? item.label,
                 ...(link && { link }),
             };
         }
         if (item.type === 'link') {
+            const linkKey = item.key ?? item.label;
             return {
                 ...item,
-                label: sidebarsTranslations[`sidebar.${sidebarName}.link.${item.label}`]
+                label: sidebarsTranslations[`sidebar.${sidebarName}.link.${linkKey}`]
                     ?.message ?? item.label,
             };
         }
         if ((item.type === 'doc' || item.type === 'ref') && item.translatable) {
+            const docKey = item.key ?? item.label;
             return {
                 ...item,
-                label: sidebarsTranslations[`sidebar.${sidebarName}.doc.${item.label}`]
+                label: sidebarsTranslations[`sidebar.${sidebarName}.doc.${docKey}`]
                     ?.message ?? item.label,
             };
         }

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/loadVersion.d.ts

@@ -7,9 +7,11 @@
 import { type DocEnv } from '../docs';
 import type { LoadedVersion, PluginOptions, VersionMetadata } from '@docusaurus/plugin-content-docs';
 import type { LoadContext } from '@docusaurus/types';
-export declare function loadVersion({ context, options, versionMetadata, env, }: {
+type LoadVersionParams = {
     context: LoadContext;
     options: PluginOptions;
     versionMetadata: VersionMetadata;
     env: DocEnv;
-}): Promise<LoadedVersion>;
+};
+export declare function loadVersion(params: LoadVersionParams): Promise<LoadedVersion>;
+export {};

package/lib/versions/loadVersion.js

@@ -16,74 +16,111 @@ const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const docs_1 = require("../docs");
 const sidebars_1 = require("../sidebars");
 const utils_2 = require("../sidebars/utils");
-async function loadVersion({ context, options, versionMetadata, env, }) {
-    const { siteDir } = context;
-    async function loadVersionDocsBase(tagsFile) {
-        const docFiles = await (0, docs_1.readVersionDocs)(versionMetadata, options);
-        if (docFiles.length === 0) {
-            throw new Error(`Docs version "${versionMetadata.versionName}" has no docs! At least one doc should exist at "${path_1.default.relative(siteDir, versionMetadata.contentPath)}".`);
-        }
-        function processVersionDoc(docFile) {
-            return (0, docs_1.processDocMetadata)({
-                docFile,
-                versionMetadata,
-                context,
-                options,
-                env,
-                tagsFile,
-            });
-        }
-        return Promise.all(docFiles.map(processVersionDoc));
+function ensureNoDuplicateDocId(docs) {
+    const duplicatesById = lodash_1.default.chain(docs)
+        .sort((d1, d2) => {
+        // Need to sort because Globby order is non-deterministic
+        // TODO maybe we should create a deterministic glob utils?
+        //  see https://github.com/sindresorhus/globby/issues/131
+        return d1.source.localeCompare(d2.source);
+    })
+        .groupBy((d) => d.id)
+        .pickBy((group) => group.length > 1)
+        .value();
+    const duplicateIdEntries = Object.entries(duplicatesById);
+    if (duplicateIdEntries.length) {
+        const idMessages = duplicateIdEntries
+            .map(([id, duplicateDocs]) => {
+            return logger_1.default.interpolate `- code=${id} found in number=${duplicateDocs.length} docs:
+  - ${duplicateDocs
+                .map((d) => (0, utils_1.aliasedSitePathToRelativePath)(d.source))
+                .join('\n  - ')}`;
+        })
+            .join('\n\n');
+        const message = `The docs plugin found docs sharing the same id:
+\n${idMessages}\n
+Docs should have distinct ids.
+In case of conflict, you can rename the docs file, or use the ${logger_1.default.code('id')} front matter to assign an explicit distinct id to each doc.
+    `;
+        throw new Error(message);
     }
-    async function doLoadVersion() {
-        const tagsFile = await (0, utils_validation_1.getTagsFile)({
-            contentPaths: versionMetadata,
-            tags: options.tags,
-        });
-        const docsBase = await loadVersionDocsBase(tagsFile);
-        // TODO we only ever need draftIds in further code, not full draft items
-        // To simplify and prevent mistakes, avoid exposing draft
-        // replace draft=>draftIds in content loaded
-        const [drafts, docs] = lodash_1.default.partition(docsBase, (doc) => doc.draft);
-        const sidebars = await (0, sidebars_1.loadSidebars)(versionMetadata.sidebarFilePath, {
-            sidebarItemsGenerator: options.sidebarItemsGenerator,
-            numberPrefixParser: options.numberPrefixParser,
-            docs,
-            drafts,
-            version: versionMetadata,
-            sidebarOptions: {
-                sidebarCollapsed: options.sidebarCollapsed,
-                sidebarCollapsible: options.sidebarCollapsible,
-            },
-            categoryLabelSlugger: (0, utils_1.createSlugger)(),
-        });
-        const sidebarsUtils = (0, utils_2.createSidebarsUtils)(sidebars);
-        const docsById = (0, docs_1.createDocsByIdIndex)(docs);
-        const allDocIds = Object.keys(docsById);
-        sidebarsUtils.checkLegacyVersionedSidebarNames({
-            sidebarFilePath: versionMetadata.sidebarFilePath,
-            versionMetadata,
-        });
-        sidebarsUtils.checkSidebarsDocIds({
-            allDocIds,
-            sidebarFilePath: versionMetadata.sidebarFilePath,
+}
+async function loadVersionDocsBase({ tagsFile, context, options, versionMetadata, env, }) {
+    const docFiles = await (0, docs_1.readVersionDocs)(versionMetadata, options);
+    if (docFiles.length === 0) {
+        throw new Error(`Docs version "${versionMetadata.versionName}" has no docs! At least one doc should exist at "${path_1.default.relative(context.siteDir, versionMetadata.contentPath)}".`);
+    }
+    function processVersionDoc(docFile) {
+        return (0, docs_1.processDocMetadata)({
+            docFile,
             versionMetadata,
+            context,
+            options,
+            env,
+            tagsFile,
         });
-        return {
-            ...versionMetadata,
-            docs: (0, docs_1.addDocNavigation)({
-                docs,
-                sidebarsUtils,
-            }),
-            drafts,
-            sidebars,
-        };
     }
+    const docs = await Promise.all(docFiles.map(processVersionDoc));
+    ensureNoDuplicateDocId(docs);
+    return docs;
+}
+async function doLoadVersion({ context, options, versionMetadata, env, }) {
+    const tagsFile = await (0, utils_validation_1.getTagsFile)({
+        contentPaths: versionMetadata,
+        tags: options.tags,
+    });
+    const docsBase = await loadVersionDocsBase({
+        tagsFile,
+        context,
+        options,
+        versionMetadata,
+        env,
+    });
+    // TODO we only ever need draftIds in further code, not full draft items
+    // To simplify and prevent mistakes, avoid exposing draft
+    // replace draft=>draftIds in content loaded
+    const [drafts, docs] = lodash_1.default.partition(docsBase, (doc) => doc.draft);
+    const sidebars = await (0, sidebars_1.loadSidebars)(versionMetadata.sidebarFilePath, {
+        sidebarItemsGenerator: options.sidebarItemsGenerator,
+        numberPrefixParser: options.numberPrefixParser,
+        docs,
+        drafts,
+        version: versionMetadata,
+        sidebarOptions: {
+            sidebarCollapsed: options.sidebarCollapsed,
+            sidebarCollapsible: options.sidebarCollapsible,
+        },
+        categoryLabelSlugger: (0, utils_1.createSlugger)(),
+    });
+    const sidebarsUtils = (0, utils_2.createSidebarsUtils)(sidebars);
+    const docsById = (0, docs_1.createDocsByIdIndex)(docs);
+    const allDocIds = Object.keys(docsById);
+    sidebarsUtils.checkLegacyVersionedSidebarNames({
+        sidebarFilePath: versionMetadata.sidebarFilePath,
+        versionMetadata,
+    });
+    sidebarsUtils.checkSidebarsDocIds({
+        allDocIds,
+        sidebarFilePath: versionMetadata.sidebarFilePath,
+        versionMetadata,
+    });
+    return {
+        ...versionMetadata,
+        docs: (0, docs_1.addDocNavigation)({
+            docs,
+            sidebarsUtils,
+        }),
+        drafts,
+        sidebars,
+    };
+}
+async function loadVersion(params) {
     try {
-        return await doLoadVersion();
+        return await doLoadVersion(params);
     }
     catch (err) {
-        logger_1.default.error `Loading of version failed for version name=${versionMetadata.versionName}`;
+        // TODO use error cause (but need to refactor many tests)
+        logger_1.default.error `Loading of version failed for version name=${params.versionMetadata.versionName}`;
         throw err;
     }
 }

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",
+  "version": "3.9.0-canary-6406",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "sideEffects": false,
@@ -35,15 +35,15 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "3.8.1",
-    "@docusaurus/logger": "3.8.1",
-    "@docusaurus/mdx-loader": "3.8.1",
-    "@docusaurus/module-type-aliases": "3.8.1",
-    "@docusaurus/theme-common": "3.8.1",
-    "@docusaurus/types": "3.8.1",
-    "@docusaurus/utils": "3.8.1",
-    "@docusaurus/utils-common": "3.8.1",
-    "@docusaurus/utils-validation": "3.8.1",
+    "@docusaurus/core": "3.9.0-canary-6406",
+    "@docusaurus/logger": "3.9.0-canary-6406",
+    "@docusaurus/mdx-loader": "3.9.0-canary-6406",
+    "@docusaurus/module-type-aliases": "3.9.0-canary-6406",
+    "@docusaurus/theme-common": "3.9.0-canary-6406",
+    "@docusaurus/types": "3.9.0-canary-6406",
+    "@docusaurus/utils": "3.9.0-canary-6406",
+    "@docusaurus/utils-common": "3.9.0-canary-6406",
+    "@docusaurus/utils-validation": "3.9.0-canary-6406",
     "@types/react-router-config": "^5.0.7",
     "combine-promises": "^1.1.0",
     "fs-extra": "^11.1.1",
@@ -65,7 +65,7 @@
     "react-dom": "^18.0.0 || ^19.0.0"
   },
   "engines": {
-    "node": ">=18.0"
+    "node": ">=20.0"
   },
-  "gitHead": "fa8ae13e668fcbc0481ce10c0a734e2a5b397293"
+  "gitHead": "796441f4f831278ffc57971fabcd4c730da9e9d7"
 }

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