@docusaurus/plugin-content-docs 3.9.1-canary-6425 → 3.9.2-alpha.0

package/lib/client/docsUtils.js

@@ -148,11 +148,18 @@ function getSidebarBreadcrumbs({ sidebarItems, pathname, onlyCategories = false,
     const breadcrumbs = [];
     function extract(items) {
         for (const item of items) {
-            if ((item.type === 'category' &&
-                (isSamePath(item.href, pathname) || extract(item.items))) ||
-                (item.type === 'link' && isSamePath(item.href, pathname))) {
-                const filtered = onlyCategories && item.type !== 'category';
-                if (!filtered) {
+            // Extract category item
+            if (item.type === 'category') {
+                if (isSamePath(item.href, pathname) || extract(item.items)) {
+                    breadcrumbs.unshift(item);
+                    return true;
+                }
+            }
+            // Extract doc item
+            else if (item.type === 'link' &&
+                item.docId &&
+                isSamePath(item.href, pathname)) {
+                if (!onlyCategories) {
                     breadcrumbs.unshift(item);
                 }
                 return true;

package/lib/docs.js

@@ -38,7 +38,7 @@ async function readVersionDocs(versionMetadata, options) {
 }
 async function doProcessDocMetadata({ docFile, versionMetadata, context, options, env, tagsFile, }) {
     const { source, content, contentPath, filePath } = docFile;
-    const { siteDir, siteConfig: { markdown: { parseFrontMatter }, }, } = context;
+    const { siteDir, siteConfig: { markdown: { parseFrontMatter }, future: { experimental_vcs: vcs }, }, } = context;
     const { frontMatter: unsafeFrontMatter, contentTitle, excerpt, } = await (0, utils_1.parseMarkdownFile)({
         filePath,
         fileContent: content,
@@ -50,7 +50,7 @@ async function doProcessDocMetadata({ docFile, versionMetadata, context, options
     // (01-MyFolder/01-MyDoc.md => MyFolder/MyDoc)
     // but allow to disable this behavior with front matter
     parse_number_prefixes: parseNumberPrefixes = true, last_update: lastUpdateFrontMatter, } = frontMatter;
-    const lastUpdate = await (0, utils_1.readLastUpdateData)(filePath, options, lastUpdateFrontMatter);
+    const lastUpdate = await (0, utils_1.readLastUpdateData)(filePath, options, lastUpdateFrontMatter, vcs);
     // E.g. api/plugins/myDoc -> myDoc; myDoc -> myDoc
     const sourceFileNameWithoutExtension = path_1.default.basename(source, path_1.default.extname(source));
     // E.g. api/plugins/myDoc -> api/plugins; myDoc -> .

package/lib/index.js

@@ -75,7 +75,7 @@ async function pluginContentDocs(context, options) {
                         versionsMetadata,
                     }),
                 ].filter((d) => typeof d === 'string'),
-                useCrossCompilerCache: siteConfig.future.experimental_faster.mdxCrossCompilerCache,
+                useCrossCompilerCache: siteConfig.future.faster.mdxCrossCompilerCache,
                 admonitions: options.admonitions,
                 remarkPlugins,
                 rehypePlugins,

package/lib/translations.js

@@ -113,8 +113,9 @@ function translateSidebar({ sidebar, sidebarName, sidebarsTranslations, }) {
             return undefined;
         }
         if (category.link.type === 'generated-index') {
-            const title = sidebarsTranslations[`sidebar.${sidebarName}.category.${category.label}.link.generated-index.title`]?.message ?? category.link.title;
-            const description = sidebarsTranslations[`sidebar.${sidebarName}.category.${category.label}.link.generated-index.description`]?.message ?? category.link.description;
+            const categoryKey = category.key ?? category.label;
+            const title = sidebarsTranslations[`sidebar.${sidebarName}.category.${categoryKey}.link.generated-index.title`]?.message ?? category.link.title;
+            const description = sidebarsTranslations[`sidebar.${sidebarName}.category.${categoryKey}.link.generated-index.description`]?.message ?? category.link.description;
             return {
                 ...category.link,
                 title,
@@ -178,12 +179,51 @@ function getVersionTranslationFiles(version) {
         },
     ];
 }
+// TODO Docusaurus v4 or later
+//  this temporarily works, but it is not an ideal solution
+//  The docs navigation can be computed and shouldn't be part of LoadedVersion
+//  We need to derive the navigation from already translated content
+//  See https://github.com/facebook/docusaurus/pull/11794
+function translateDocNavigation(docs, translatedSidebars) {
+    // Build a map of permalink -> translated label for generated-index categories
+    const translatedLabelByPermalink = new Map();
+    for (const sidebar of Object.values(translatedSidebars)) {
+        for (const category of (0, utils_2.collectSidebarCategories)(sidebar)) {
+            if (category.link?.type === 'generated-index') {
+                translatedLabelByPermalink.set(category.link.permalink, category.label);
+            }
+        }
+    }
+    if (translatedLabelByPermalink.size === 0) {
+        return docs;
+    }
+    return docs.map((doc) => {
+        const previous = doc.previous && translatedLabelByPermalink.has(doc.previous.permalink)
+            ? {
+                ...doc.previous,
+                title: translatedLabelByPermalink.get(doc.previous.permalink),
+            }
+            : doc.previous;
+        const next = doc.next && translatedLabelByPermalink.has(doc.next.permalink)
+            ? {
+                ...doc.next,
+                title: translatedLabelByPermalink.get(doc.next.permalink),
+            }
+            : doc.next;
+        if (previous === doc.previous && next === doc.next) {
+            return doc;
+        }
+        return { ...doc, previous, next };
+    });
+}
 function translateVersion(version, translationFiles) {
     const versionTranslations = translationFiles[getVersionFileName(version.versionName)].content;
+    const translatedSidebars = translateSidebars(version, versionTranslations);
     return {
         ...version,
         label: versionTranslations['version.label']?.message ?? version.label,
-        sidebars: translateSidebars(version, versionTranslations),
+        sidebars: translatedSidebars,
+        docs: translateDocNavigation(version.docs, translatedSidebars),
     };
 }
 function getVersionsTranslationFiles(versions) {

package/package.json

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

package/src/client/docsUtils.tsx

@@ -234,15 +234,22 @@ function getSidebarBreadcrumbs({
 }): PropSidebarBreadcrumbsItem[] {
   const breadcrumbs: PropSidebarBreadcrumbsItem[] = [];
 
-  function extract(items: PropSidebarItem[]) {
+  function extract(items: PropSidebarItem[]): boolean {
     for (const item of items) {
-      if (
-        (item.type === 'category' &&
-          (isSamePath(item.href, pathname) || extract(item.items))) ||
-        (item.type === 'link' && isSamePath(item.href, pathname))
+      // Extract category item
+      if (item.type === 'category') {
+        if (isSamePath(item.href, pathname) || extract(item.items)) {
+          breadcrumbs.unshift(item);
+          return true;
+        }
+      }
+      // Extract doc item
+      else if (
+        item.type === 'link' &&
+        item.docId &&
+        isSamePath(item.href, pathname)
       ) {
-        const filtered = onlyCategories && item.type !== 'category';
-        if (!filtered) {
+        if (!onlyCategories) {
           breadcrumbs.unshift(item);
         }
         return true;

package/src/docs.ts

@@ -97,6 +97,7 @@ async function doProcessDocMetadata({
     siteDir,
     siteConfig: {
       markdown: {parseFrontMatter},
+      future: {experimental_vcs: vcs},
     },
   } = context;
 
@@ -125,6 +126,7 @@ async function doProcessDocMetadata({
     filePath,
     options,
     lastUpdateFrontMatter,
+    vcs,
   );
 
   // E.g. api/plugins/myDoc -> myDoc; myDoc -> myDoc

package/src/index.ts

@@ -131,8 +131,7 @@ export default async function pluginContentDocs(
           }),
         ].filter((d): d is string => typeof d === 'string'),
 
-        useCrossCompilerCache:
-          siteConfig.future.experimental_faster.mdxCrossCompilerCache,
+        useCrossCompilerCache: siteConfig.future.faster.mdxCrossCompilerCache,
         admonitions: options.admonitions,
         remarkPlugins,
         rehypePlugins,

package/src/translations.ts

@@ -177,13 +177,14 @@ function translateSidebar({
       return undefined;
     }
     if (category.link.type === 'generated-index') {
+      const categoryKey = category.key ?? category.label;
       const title =
         sidebarsTranslations[
-          `sidebar.${sidebarName}.category.${category.label}.link.generated-index.title`
+          `sidebar.${sidebarName}.category.${categoryKey}.link.generated-index.title`
         ]?.message ?? category.link.title;
       const description =
         sidebarsTranslations[
-          `sidebar.${sidebarName}.category.${category.label}.link.generated-index.description`
+          `sidebar.${sidebarName}.category.${categoryKey}.link.generated-index.description`
         ]?.message ?? category.link.description;
       return {
         ...category.link,
@@ -268,16 +269,64 @@ function getVersionTranslationFiles(version: LoadedVersion): TranslationFile[] {
     },
   ];
 }
+
+// TODO Docusaurus v4 or later
+//  this temporarily works, but it is not an ideal solution
+//  The docs navigation can be computed and shouldn't be part of LoadedVersion
+//  We need to derive the navigation from already translated content
+//  See https://github.com/facebook/docusaurus/pull/11794
+function translateDocNavigation(
+  docs: LoadedVersion['docs'],
+  translatedSidebars: Sidebars,
+): LoadedVersion['docs'] {
+  // Build a map of permalink -> translated label for generated-index categories
+  const translatedLabelByPermalink = new Map<string, string>();
+  for (const sidebar of Object.values(translatedSidebars)) {
+    for (const category of collectSidebarCategories(sidebar)) {
+      if (category.link?.type === 'generated-index') {
+        translatedLabelByPermalink.set(category.link.permalink, category.label);
+      }
+    }
+  }
+
+  if (translatedLabelByPermalink.size === 0) {
+    return docs;
+  }
+
+  return docs.map((doc) => {
+    const previous =
+      doc.previous && translatedLabelByPermalink.has(doc.previous.permalink)
+        ? {
+            ...doc.previous,
+            title: translatedLabelByPermalink.get(doc.previous.permalink)!,
+          }
+        : doc.previous;
+    const next =
+      doc.next && translatedLabelByPermalink.has(doc.next.permalink)
+        ? {
+            ...doc.next,
+            title: translatedLabelByPermalink.get(doc.next.permalink)!,
+          }
+        : doc.next;
+    if (previous === doc.previous && next === doc.next) {
+      return doc;
+    }
+    return {...doc, previous, next};
+  });
+}
+
 function translateVersion(
   version: LoadedVersion,
   translationFiles: {[fileName: string]: TranslationFile},
 ): LoadedVersion {
   const versionTranslations =
     translationFiles[getVersionFileName(version.versionName)]!.content;
+  const translatedSidebars = translateSidebars(version, versionTranslations);
   return {
     ...version,
     label: versionTranslations['version.label']?.message ?? version.label,
-    sidebars: translateSidebars(version, versionTranslations),
+    sidebars: translatedSidebars,
+    docs: translateDocNavigation(version.docs, translatedSidebars),
   };
 }