@docusaurus/plugin-content-docs 0.0.0-4775 → 0.0.0-4778

package/lib/sidebars/generator.js

@@ -105,9 +105,6 @@ Available doc IDs:
         }
         function createCategoryItem(dir, fullPath, folderName) {
             const categoryMetadata = categoriesMetadata[(0, utils_1.posixPath)(path_1.default.join(autogenDir, fullPath))];
-            const className = categoryMetadata?.className;
-            const customProps = categoryMetadata?.customProps;
-            const { filename, numberPrefix } = numberPrefixParser(folderName);
             const allItems = Object.entries(dir).map(([key, content]) => dirToItem(content, key, `${fullPath}/${key}`));
             // Try to match a doc inside the category folder,
             // using the "local id" (myDoc) or "qualified id" (dirName/myDoc)
@@ -123,34 +120,49 @@ Available doc IDs:
                     return isCategoryIndex((0, docs_1.toCategoryIndexMatcherParam)(doc));
                 });
             }
-            function getCategoryLinkedDocId() {
+            // In addition to the ID, this function also retrieves metadata of the
+            // linked doc that could be used as fallback values for category metadata
+            function getCategoryLinkedDocMetadata() {
                 const link = categoryMetadata?.link;
-                if (link !== undefined) {
-                    if (link && link.type === 'doc') {
-                        return findDocByLocalId(link.id)?.id || getDoc(link.id).id;
-                    }
+                if (link !== undefined && link?.type !== 'doc') {
                     // If a link is explicitly specified, we won't apply conventions
                     return undefined;
                 }
-                // Apply default convention to pick index.md, README.md or
-                // <categoryName>.md as the category doc
-                return findConventionalCategoryDocLink()?.id;
+                const id = link
+                    ? findDocByLocalId(link.id)?.id ?? getDoc(link.id).id
+                    : findConventionalCategoryDocLink()?.id;
+                if (!id) {
+                    return undefined;
+                }
+                const doc = getDoc(id);
+                return {
+                    id,
+                    position: doc.sidebarPosition,
+                    label: doc.frontMatter.sidebar_label ?? doc.title,
+                    customProps: doc.frontMatter.sidebar_custom_props,
+                    className: doc.frontMatter.sidebar_class_name,
+                };
             }
-            const categoryLinkedDocId = getCategoryLinkedDocId();
-            const link = categoryLinkedDocId
+            const categoryLinkedDoc = getCategoryLinkedDocMetadata();
+            const link = categoryLinkedDoc
                 ? {
                     type: 'doc',
-                    id: categoryLinkedDocId, // We "remap" a potentially "local id" to a "qualified id"
+                    id: categoryLinkedDoc.id, // We "remap" a potentially "local id" to a "qualified id"
                 }
                 : categoryMetadata?.link;
             // If a doc is linked, remove it from the category subItems
-            const items = allItems.filter((item) => !(item.type === 'doc' && item.id === categoryLinkedDocId));
+            const items = allItems.filter((item) => !(item.type === 'doc' && item.id === categoryLinkedDoc?.id));
+            const className = categoryMetadata?.className ?? categoryLinkedDoc?.className;
+            const customProps = categoryMetadata?.customProps ?? categoryLinkedDoc?.customProps;
+            const { filename, numberPrefix } = numberPrefixParser(folderName);
             return {
                 type: 'category',
-                label: categoryMetadata?.label ?? filename,
+                label: categoryMetadata?.label ?? categoryLinkedDoc?.label ?? filename,
                 collapsible: categoryMetadata?.collapsible,
                 collapsed: categoryMetadata?.collapsed,
-                position: categoryMetadata?.position ?? numberPrefix,
+                position: categoryMetadata?.position ??
+                    categoryLinkedDoc?.position ??
+                    numberPrefix,
                 source: folderName,
                 ...(customProps !== undefined && { customProps }),
                 ...(className !== undefined && { className }),

package/lib/sidebars/processor.js

@@ -17,6 +17,7 @@ function toSidebarItemsGeneratorDoc(doc) {
     return lodash_1.default.pick(doc, [
         'id',
         'unversionedId',
+        'title',
         'frontMatter',
         'source',
         'sourceDirName',

package/lib/sidebars/types.d.ts

@@ -146,7 +146,7 @@ export declare type CategoryMetadataFile = {
         [key: string]: unknown;
     };
 };
-export declare type SidebarItemsGeneratorDoc = Pick<DocMetadataBase, 'id' | 'unversionedId' | 'frontMatter' | 'source' | 'sourceDirName' | 'sidebarPosition'>;
+export declare type SidebarItemsGeneratorDoc = Pick<DocMetadataBase, 'id' | 'unversionedId' | 'title' | 'frontMatter' | 'source' | 'sourceDirName' | 'sidebarPosition'>;
 export declare type SidebarItemsGeneratorVersion = Pick<VersionMetadata, 'versionName' | 'contentPath'>;
 export declare type SidebarItemsGeneratorArgs = {
     item: SidebarItemAutogenerated;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "0.0.0-4775",
+  "version": "0.0.0-4778",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "exports": {
@@ -23,11 +23,11 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4775",
-    "@docusaurus/logger": "0.0.0-4775",
-    "@docusaurus/mdx-loader": "0.0.0-4775",
-    "@docusaurus/utils": "0.0.0-4775",
-    "@docusaurus/utils-validation": "0.0.0-4775",
+    "@docusaurus/core": "0.0.0-4778",
+    "@docusaurus/logger": "0.0.0-4778",
+    "@docusaurus/mdx-loader": "0.0.0-4778",
+    "@docusaurus/utils": "0.0.0-4778",
+    "@docusaurus/utils-validation": "0.0.0-4778",
     "combine-promises": "^1.1.0",
     "fs-extra": "^10.0.1",
     "import-fresh": "^3.3.0",
@@ -39,8 +39,8 @@
     "webpack": "^5.70.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4775",
-    "@docusaurus/types": "0.0.0-4775",
+    "@docusaurus/module-type-aliases": "0.0.0-4778",
+    "@docusaurus/types": "0.0.0-4778",
     "@types/js-yaml": "^4.0.5",
     "@types/picomatch": "^2.3.0",
     "commander": "^5.1.0",
@@ -56,5 +56,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "c5116b4d028c288e4adca7a00a781655dae43131"
+  "gitHead": "da6091ef54123897a8363f92f62d4d97d3428fc3"
 }

package/src/sidebars/generator.ts

@@ -158,9 +158,6 @@ Available doc IDs:
     ): WithPosition<NormalizedSidebarItemCategory> {
       const categoryMetadata =
         categoriesMetadata[posixPath(path.join(autogenDir, fullPath))];
-      const className = categoryMetadata?.className;
-      const customProps = categoryMetadata?.customProps;
-      const {filename, numberPrefix} = numberPrefixParser(folderName);
       const allItems = Object.entries(dir).map(([key, content]) =>
         dirToItem(content, key, `${fullPath}/${key}`),
       );
@@ -184,41 +181,65 @@ Available doc IDs:
         });
       }
 
-      function getCategoryLinkedDocId(): string | undefined {
-        const link = categoryMetadata?.link;
-        if (link !== undefined) {
-          if (link && link.type === 'doc') {
-            return findDocByLocalId(link.id)?.id || getDoc(link.id).id;
+      // In addition to the ID, this function also retrieves metadata of the
+      // linked doc that could be used as fallback values for category metadata
+      function getCategoryLinkedDocMetadata():
+        | {
+            id: string;
+            position?: number;
+            label?: string;
+            customProps?: {[key: string]: unknown};
+            className?: string;
           }
+        | undefined {
+        const link = categoryMetadata?.link;
+        if (link !== undefined && link?.type !== 'doc') {
           // If a link is explicitly specified, we won't apply conventions
           return undefined;
         }
-        // Apply default convention to pick index.md, README.md or
-        // <categoryName>.md as the category doc
-        return findConventionalCategoryDocLink()?.id;
+        const id = link
+          ? findDocByLocalId(link.id)?.id ?? getDoc(link.id).id
+          : findConventionalCategoryDocLink()?.id;
+        if (!id) {
+          return undefined;
+        }
+        const doc = getDoc(id);
+        return {
+          id,
+          position: doc.sidebarPosition,
+          label: doc.frontMatter.sidebar_label ?? doc.title,
+          customProps: doc.frontMatter.sidebar_custom_props,
+          className: doc.frontMatter.sidebar_class_name,
+        };
       }
-
-      const categoryLinkedDocId = getCategoryLinkedDocId();
-
+      const categoryLinkedDoc = getCategoryLinkedDocMetadata();
       const link: SidebarItemCategoryLinkConfig | null | undefined =
-        categoryLinkedDocId
+        categoryLinkedDoc
           ? {
               type: 'doc',
-              id: categoryLinkedDocId, // We "remap" a potentially "local id" to a "qualified id"
+              id: categoryLinkedDoc.id, // We "remap" a potentially "local id" to a "qualified id"
             }
           : categoryMetadata?.link;
-
       // If a doc is linked, remove it from the category subItems
       const items = allItems.filter(
-        (item) => !(item.type === 'doc' && item.id === categoryLinkedDocId),
+        (item) => !(item.type === 'doc' && item.id === categoryLinkedDoc?.id),
       );
 
+      const className =
+        categoryMetadata?.className ?? categoryLinkedDoc?.className;
+      const customProps =
+        categoryMetadata?.customProps ?? categoryLinkedDoc?.customProps;
+      const {filename, numberPrefix} = numberPrefixParser(folderName);
+
       return {
         type: 'category',
-        label: categoryMetadata?.label ?? filename,
+        label: categoryMetadata?.label ?? categoryLinkedDoc?.label ?? filename,
         collapsible: categoryMetadata?.collapsible,
         collapsed: categoryMetadata?.collapsed,
-        position: categoryMetadata?.position ?? numberPrefix,
+        position:
+          categoryMetadata?.position ??
+          categoryLinkedDoc?.position ??
+          numberPrefix,
         source: folderName,
         ...(customProps !== undefined && {customProps}),
         ...(className !== undefined && {className}),

package/src/sidebars/processor.ts

@@ -31,6 +31,7 @@ function toSidebarItemsGeneratorDoc(
   return _.pick(doc, [
     'id',
     'unversionedId',
+    'title',
     'frontMatter',
     'source',
     'sourceDirName',

package/src/sidebars/types.ts

@@ -231,6 +231,7 @@ export type SidebarItemsGeneratorDoc = Pick<
   DocMetadataBase,
   | 'id'
   | 'unversionedId'
+  | 'title'
   | 'frontMatter'
   | 'source'
   | 'sourceDirName'