@docusaurus/plugin-content-docs 0.0.0-4675 → 0.0.0-4678

package/lib/sidebars/generator.js

@@ -104,6 +104,7 @@ const DefaultSidebarItemsGenerator = async ({ numberPrefixParser, isCategoryInde
         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,
@@ -149,6 +150,7 @@ const DefaultSidebarItemsGenerator = async ({ numberPrefixParser, isCategoryInde
                 collapsed: categoryMetadata?.collapsed,
                 position: categoryMetadata?.position ?? numberPrefix,
                 source: folderName,
+                ...(customProps !== undefined && { customProps }),
                 ...(className !== undefined && { className }),
                 items,
                 ...(link && { link }),

package/lib/sidebars/types.d.ts

@@ -138,6 +138,7 @@ export declare type CategoryMetadataFile = {
     collapsible?: boolean;
     className?: string;
     link?: SidebarItemCategoryLinkConfig | null;
+    customProps?: Record<string, unknown>;
 };
 export declare type SidebarItemsGeneratorDoc = Pick<DocMetadataBase, 'id' | 'unversionedId' | 'frontMatter' | 'source' | 'sourceDirName' | 'sidebarPosition'>;
 export declare type SidebarItemsGeneratorVersion = Pick<VersionMetadata, 'versionName' | 'contentPath'>;

package/lib/sidebars/validation.js

@@ -130,6 +130,7 @@ const categoryMetadataFileSchema = utils_validation_1.Joi.object({
     collapsible: utils_validation_1.Joi.boolean(),
     className: utils_validation_1.Joi.string(),
     link: sidebarItemCategoryLinkSchema,
+    customProps: utils_validation_1.Joi.object().unknown(),
 });
 function validateCategoryMetadataFile(unsafeContent) {
     return utils_validation_1.Joi.attempt(unsafeContent, categoryMetadataFileSchema);

package/package.json

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

package/src/sidebars/generator.ts

@@ -159,6 +159,7 @@ export const DefaultSidebarItemsGenerator: SidebarItemsGenerator = async ({
       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}`),
@@ -219,6 +220,7 @@ export const DefaultSidebarItemsGenerator: SidebarItemsGenerator = async ({
         collapsed: categoryMetadata?.collapsed,
         position: categoryMetadata?.position ?? numberPrefix,
         source: folderName,
+        ...(customProps !== undefined && {customProps}),
         ...(className !== undefined && {className}),
         items,
         ...(link && {link}),

package/src/sidebars/types.ts

@@ -216,6 +216,7 @@ export type CategoryMetadataFile = {
   collapsible?: boolean;
   className?: string;
   link?: SidebarItemCategoryLinkConfig | null;
+  customProps?: Record<string, unknown>;
 
   // TODO should we allow "items" here? how would this work? would an
   // "autogenerated" type be allowed?

package/src/sidebars/validation.ts

@@ -164,6 +164,7 @@ const categoryMetadataFileSchema = Joi.object<CategoryMetadataFile>({
   collapsible: Joi.boolean(),
   className: Joi.string(),
   link: sidebarItemCategoryLinkSchema,
+  customProps: Joi.object().unknown(),
 });
 
 export function validateCategoryMetadataFile(