@docusaurus/plugin-content-docs 0.0.0-5127 → 0.0.0-5130

package/lib/props.js

@@ -43,10 +43,24 @@ Available document ids are:
                 return undefined;
         }
     }
+    function getCategoryLinkCustomProps(link) {
+        switch (link?.type) {
+            case 'doc':
+                return getDocById(link.id).frontMatter.sidebar_custom_props;
+            default:
+                return undefined;
+        }
+    }
     function convertCategory(item) {
         const { link, ...rest } = item;
         const href = getCategoryLinkHref(link);
-        return { ...rest, items: item.items.map(normalizeItem), ...(href && { href }) };
+        const customProps = item.customProps ?? getCategoryLinkCustomProps(link);
+        return {
+            ...rest,
+            items: item.items.map(normalizeItem),
+            ...(href && { href }),
+            ...(customProps && { customProps }),
+        };
     }
     function normalizeItem(item) {
         switch (item.type) {

package/lib/sidebars/normalization.js

@@ -30,6 +30,10 @@ function normalizeItem(item) {
         // This will never throw anyways
         return normalizeSidebar(item, 'sidebar items slice');
     }
+    if ((item.type === 'doc' || item.type === 'ref') &&
+        typeof item.label === 'string') {
+        return [{ ...item, translatable: true }];
+    }
     if (item.type === 'category') {
         const normalizedCategory = {
             ...item,

package/lib/sidebars/types.d.ts

@@ -22,6 +22,11 @@ export declare type SidebarItemDoc = SidebarItemBase & {
     type: 'doc' | 'ref';
     label?: string;
     id: string;
+    /**
+     * This is an internal marker. Items with labels defined in the config needs
+     * to be translated with JSON
+     */
+    translatable?: true;
 };
 export declare type SidebarItemHtml = SidebarItemBase & {
     type: 'html';
@@ -73,7 +78,7 @@ export declare type SidebarItemCategoryConfig = Expand<Optional<SidebarItemCateg
 export declare type SidebarCategoriesShorthand = {
     [sidebarCategory: string]: SidebarCategoriesShorthand | SidebarItemConfig[];
 };
-export declare type SidebarItemConfig = SidebarItemDoc | SidebarItemHtml | SidebarItemLink | SidebarItemAutogenerated | SidebarItemCategoryConfig | string | SidebarCategoriesShorthand;
+export declare type SidebarItemConfig = Omit<SidebarItemDoc, 'translatable'> | SidebarItemHtml | SidebarItemLink | SidebarItemAutogenerated | SidebarItemCategoryConfig | string | SidebarCategoriesShorthand;
 export declare type SidebarConfig = SidebarCategoriesShorthand | SidebarItemConfig[];
 export declare type SidebarsConfig = {
     [sidebarId: string]: SidebarConfig;

package/lib/sidebars/utils.d.ts

@@ -11,6 +11,7 @@ export declare function transformSidebarItems(sidebar: Sidebar, updateFn: (item:
 export declare function collectSidebarDocItems(sidebar: Sidebar): SidebarItemDoc[];
 export declare function collectSidebarCategories(sidebar: Sidebar): SidebarItemCategory[];
 export declare function collectSidebarLinks(sidebar: Sidebar): SidebarItemLink[];
+export declare function collectSidebarRefs(sidebar: Sidebar): SidebarItemDoc[];
 export declare function collectSidebarDocIds(sidebar: Sidebar): string[];
 export declare function collectSidebarNavigation(sidebar: Sidebar): SidebarNavigationItem[];
 export declare function collectSidebarsDocIds(sidebars: Sidebars): {

package/lib/sidebars/utils.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toNavigationLink = exports.toDocNavigationLink = exports.createSidebarsUtils = exports.collectSidebarsNavigations = exports.collectSidebarsDocIds = exports.collectSidebarNavigation = exports.collectSidebarDocIds = exports.collectSidebarLinks = exports.collectSidebarCategories = exports.collectSidebarDocItems = exports.transformSidebarItems = exports.isCategoriesShorthand = void 0;
+exports.toNavigationLink = exports.toDocNavigationLink = exports.createSidebarsUtils = exports.collectSidebarsNavigations = exports.collectSidebarsDocIds = exports.collectSidebarNavigation = exports.collectSidebarDocIds = exports.collectSidebarRefs = exports.collectSidebarLinks = exports.collectSidebarCategories = exports.collectSidebarDocItems = exports.transformSidebarItems = exports.isCategoriesShorthand = void 0;
 const tslib_1 = require("tslib");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const utils_1 = require("@docusaurus/utils");
@@ -55,6 +55,10 @@ function collectSidebarLinks(sidebar) {
     return collectSidebarItemsOfType('link', sidebar);
 }
 exports.collectSidebarLinks = collectSidebarLinks;
+function collectSidebarRefs(sidebar) {
+    return collectSidebarItemsOfType('ref', sidebar);
+}
+exports.collectSidebarRefs = collectSidebarRefs;
 // /!\ docId order matters for navigation!
 function collectSidebarDocIds(sidebar) {
     return flattenSidebarItems(sidebar).flatMap((item) => {

package/lib/sidebars/validation.js

@@ -26,6 +26,7 @@ const sidebarItemDocSchema = sidebarItemBaseSchema.append({
     type: utils_validation_1.Joi.string().valid('doc', 'ref').required(),
     id: utils_validation_1.Joi.string().required(),
     label: utils_validation_1.Joi.string(),
+    translatable: utils_validation_1.Joi.boolean(),
 });
 const sidebarItemHtmlSchema = sidebarItemBaseSchema.append({
     type: 'html',

package/lib/translations.js

@@ -71,7 +71,17 @@ function getSidebarTranslationFileContent(sidebar, sidebarName) {
             description: `The label for link ${link.label} in sidebar ${sidebarName}, linking to ${link.href}`,
         },
     ]));
-    return (0, utils_1.mergeTranslations)([categoryContent, linksContent]);
+    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]);
 }
 function translateSidebar({ sidebar, sidebarName, sidebarsTranslations, }) {
     function transformSidebarCategoryLink(category) {
@@ -106,6 +116,13 @@ function translateSidebar({ sidebar, sidebarName, sidebarsTranslations, }) {
                     ?.message ?? item.label,
             };
         }
+        if ((item.type === 'doc' || item.type === 'ref') && item.translatable) {
+            return {
+                ...item,
+                label: sidebarsTranslations[`sidebar.${sidebarName}.doc.${item.label}`]
+                    ?.message ?? item.label,
+            };
+        }
         return item;
     });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "0.0.0-5127",
+  "version": "0.0.0-5130",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "sideEffects": false,
@@ -34,13 +34,13 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-5127",
-    "@docusaurus/logger": "0.0.0-5127",
-    "@docusaurus/mdx-loader": "0.0.0-5127",
-    "@docusaurus/module-type-aliases": "0.0.0-5127",
-    "@docusaurus/types": "0.0.0-5127",
-    "@docusaurus/utils": "0.0.0-5127",
-    "@docusaurus/utils-validation": "0.0.0-5127",
+    "@docusaurus/core": "0.0.0-5130",
+    "@docusaurus/logger": "0.0.0-5130",
+    "@docusaurus/mdx-loader": "0.0.0-5130",
+    "@docusaurus/module-type-aliases": "0.0.0-5130",
+    "@docusaurus/types": "0.0.0-5130",
+    "@docusaurus/utils": "0.0.0-5130",
+    "@docusaurus/utils-validation": "0.0.0-5130",
     "@types/react-router-config": "^5.0.6",
     "combine-promises": "^1.1.0",
     "fs-extra": "^10.1.0",
@@ -67,5 +67,5 @@
   "engines": {
     "node": ">=16.14"
   },
-  "gitHead": "26f1f87a977871d3209372752c2753379c64e7f3"
+  "gitHead": "6130c50c8f8ae0cfd19c4b37a00018d5ccf9c001"
 }

package/src/props.ts

@@ -73,10 +73,28 @@ Available document ids are:
     }
   }
 
+  function getCategoryLinkCustomProps(
+    link: SidebarItemCategoryLink | undefined,
+  ) {
+    switch (link?.type) {
+      case 'doc':
+        return getDocById(link.id).frontMatter.sidebar_custom_props;
+      default:
+        return undefined;
+    }
+  }
+
   function convertCategory(item: SidebarItemCategory): PropSidebarItemCategory {
     const {link, ...rest} = item;
     const href = getCategoryLinkHref(link);
-    return {...rest, items: item.items.map(normalizeItem), ...(href && {href})};
+    const customProps = item.customProps ?? getCategoryLinkCustomProps(link);
+
+    return {
+      ...rest,
+      items: item.items.map(normalizeItem),
+      ...(href && {href}),
+      ...(customProps && {customProps}),
+    };
   }
 
   function normalizeItem(item: SidebarItem): PropSidebarItem {

package/src/sidebars/normalization.ts

@@ -44,6 +44,12 @@ export function normalizeItem(
     // This will never throw anyways
     return normalizeSidebar(item, 'sidebar items slice');
   }
+  if (
+    (item.type === 'doc' || item.type === 'ref') &&
+    typeof item.label === 'string'
+  ) {
+    return [{...item, translatable: true}];
+  }
   if (item.type === 'category') {
     const normalizedCategory: NormalizedSidebarItemCategory = {
       ...item,

package/src/sidebars/types.ts

@@ -27,6 +27,11 @@ export type SidebarItemDoc = SidebarItemBase & {
   type: 'doc' | 'ref';
   label?: string;
   id: string;
+  /**
+   * This is an internal marker. Items with labels defined in the config needs
+   * to be translated with JSON
+   */
+  translatable?: true;
 };
 
 export type SidebarItemHtml = SidebarItemBase & {
@@ -94,7 +99,7 @@ export type SidebarCategoriesShorthand = {
 };
 
 export type SidebarItemConfig =
-  | SidebarItemDoc
+  | Omit<SidebarItemDoc, 'translatable'>
   | SidebarItemHtml
   | SidebarItemLink
   | SidebarItemAutogenerated

package/src/sidebars/utils.ts

@@ -81,6 +81,9 @@ export function collectSidebarCategories(
 export function collectSidebarLinks(sidebar: Sidebar): SidebarItemLink[] {
   return collectSidebarItemsOfType('link', sidebar);
 }
+export function collectSidebarRefs(sidebar: Sidebar): SidebarItemDoc[] {
+  return collectSidebarItemsOfType('ref', sidebar);
+}
 
 // /!\ docId order matters for navigation!
 export function collectSidebarDocIds(sidebar: Sidebar): string[] {

package/src/sidebars/validation.ts

@@ -47,6 +47,7 @@ const sidebarItemDocSchema = sidebarItemBaseSchema.append<SidebarItemDoc>({
   type: Joi.string().valid('doc', 'ref').required(),
   id: Joi.string().required(),
   label: Joi.string(),
+  translatable: Joi.boolean(),
 });
 
 const sidebarItemHtmlSchema = sidebarItemBaseSchema.append<SidebarItemHtml>({

package/src/translations.ts

@@ -12,6 +12,8 @@ import {
   collectSidebarCategories,
   transformSidebarItems,
   collectSidebarLinks,
+  collectSidebarDocItems,
+  collectSidebarRefs,
 } from './sidebars/utils';
 import type {
   LoadedVersion,
@@ -111,7 +113,22 @@ function getSidebarTranslationFileContent(
     ]),
   );
 
-  return mergeTranslations([categoryContent, linksContent]);
+  const docs = collectSidebarDocItems(sidebar)
+    .concat(collectSidebarRefs(sidebar))
+    .filter((item) => item.translatable);
+  const docLinksContent: TranslationFileContent = 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 mergeTranslations([categoryContent, linksContent, docLinksContent]);
 }
 
 function translateSidebar({
@@ -166,6 +183,14 @@ function translateSidebar({
             ?.message ?? item.label,
       };
     }
+    if ((item.type === 'doc' || item.type === 'ref') && item.translatable) {
+      return {
+        ...item,
+        label:
+          sidebarsTranslations[`sidebar.${sidebarName}.doc.${item.label!}`]
+            ?.message ?? item.label,
+      };
+    }
     return item;
   });
 }