@docusaurus/plugin-content-docs 0.0.0-4357 → 0.0.0-4360

package/lib/categoryGeneratedIndex.js

@@ -18,6 +18,8 @@ function getCategoryGeneratedIndexMetadata({ category, sidebarsUtils, docsById,
     return {
         title: (_a = category.link.title) !== null && _a !== void 0 ? _a : category.label,
         description: category.link.description,
+        image: category.link.image,
+        keywords: category.link.keywords,
         slug: category.link.slug,
         permalink: category.link.permalink,
         sidebar: sidebarName,

package/lib/routes.js

@@ -14,13 +14,15 @@ const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
 async function createCategoryGeneratedIndexRoutes({ version, actions, docCategoryGeneratedIndexComponent, }) {
     const slugs = (0, utils_1.createSlugger)();
     async function createCategoryGeneratedIndexRoute(categoryGeneratedIndex) {
-        const { sidebar, title, description, slug, permalink, previous, next } = categoryGeneratedIndex;
+        const { sidebar, title, description, slug, permalink, previous, next, image, keywords, } = categoryGeneratedIndex;
         const propFileName = slugs.slug(`${version.versionPath}-${categoryGeneratedIndex.sidebar}-category-${categoryGeneratedIndex.title}`);
         const prop = {
             title,
             description,
             slug,
             permalink,
+            image,
+            keywords,
             navigation: {
                 previous,
                 next,

package/lib/sidebars/types.d.ts

@@ -42,6 +42,8 @@ export declare type SidebarItemCategoryLinkGeneratedIndexConfig = {
     slug?: string;
     title?: string;
     description?: string;
+    image?: string;
+    keywords?: string | readonly string[];
 };
 export declare type SidebarItemCategoryLinkGeneratedIndex = {
     type: 'generated-index';
@@ -49,6 +51,8 @@ export declare type SidebarItemCategoryLinkGeneratedIndex = {
     permalink: string;
     title?: string;
     description?: string;
+    image?: string;
+    keywords?: string | readonly string[];
 };
 export declare type SidebarItemCategoryLinkConfig = SidebarItemCategoryLinkDoc | SidebarItemCategoryLinkGeneratedIndexConfig;
 export declare type SidebarItemCategoryLink = SidebarItemCategoryLinkDoc | SidebarItemCategoryLinkGeneratedIndex;

package/lib/sidebars/validation.js

@@ -50,6 +50,8 @@ const sidebarItemCategoryLinkSchema = utils_validation_1.Joi.object()
                 // permalink: Joi.string().optional(), // No, this one is not in the user config, only in the normalized version
                 title: utils_validation_1.Joi.string().optional(),
                 description: utils_validation_1.Joi.string().optional(),
+                image: utils_validation_1.Joi.string().optional(),
+                keywords: [utils_validation_1.Joi.string(), utils_validation_1.Joi.array().items(utils_validation_1.Joi.string())],
             }),
         },
         {

package/lib/types.d.ts

@@ -144,6 +144,8 @@ export declare type CategoryGeneratedIndexMetadata = {
     sidebar: string;
     previous?: DocNavLink;
     next?: DocNavLink;
+    image?: string;
+    keywords?: string | readonly string[];
 };
 export declare type SourceToPermalink = {
     [source: string]: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "0.0.0-4357",
+  "version": "0.0.0-4360",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-docs.d.ts",
@@ -18,11 +18,11 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4357",
-    "@docusaurus/logger": "0.0.0-4357",
-    "@docusaurus/mdx-loader": "0.0.0-4357",
-    "@docusaurus/utils": "0.0.0-4357",
-    "@docusaurus/utils-validation": "0.0.0-4357",
+    "@docusaurus/core": "0.0.0-4360",
+    "@docusaurus/logger": "0.0.0-4360",
+    "@docusaurus/mdx-loader": "0.0.0-4360",
+    "@docusaurus/utils": "0.0.0-4360",
+    "@docusaurus/utils-validation": "0.0.0-4360",
     "combine-promises": "^1.1.0",
     "escape-string-regexp": "^4.0.0",
     "fs-extra": "^10.0.0",
@@ -38,8 +38,8 @@
     "webpack": "^5.61.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4357",
-    "@docusaurus/types": "0.0.0-4357",
+    "@docusaurus/module-type-aliases": "0.0.0-4360",
+    "@docusaurus/types": "0.0.0-4360",
     "@types/js-yaml": "^4.0.0",
     "@types/picomatch": "^2.2.1",
     "commander": "^5.1.0",
@@ -53,5 +53,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "69a854a40c08a943c1ea556470a44574ebcc6979"
+  "gitHead": "92744da65a37c440a0d3077b217f4e0033b664ce"
 }

package/src/categoryGeneratedIndex.ts

@@ -28,6 +28,8 @@ function getCategoryGeneratedIndexMetadata({
   return {
     title: category.link.title ?? category.label,
     description: category.link.description,
+    image: category.link.image,
+    keywords: category.link.keywords,
     slug: category.link.slug,
     permalink: category.link.permalink,
     sidebar: sidebarName,

package/src/plugin-content-docs.d.ts

@@ -42,6 +42,8 @@ declare module '@docusaurus/plugin-content-docs' {
   export type PropCategoryGeneratedIndex = {
     title: string;
     description?: string;
+    image?: string;
+    keywords?: string | readonly string[];
     slug: string;
     permalink: string;
     navigation: PropNavigation;

package/src/routes.ts

@@ -30,8 +30,17 @@ export async function createCategoryGeneratedIndexRoutes({
   async function createCategoryGeneratedIndexRoute(
     categoryGeneratedIndex: CategoryGeneratedIndexMetadata,
   ): Promise<RouteConfig> {
-    const {sidebar, title, description, slug, permalink, previous, next} =
-      categoryGeneratedIndex;
+    const {
+      sidebar,
+      title,
+      description,
+      slug,
+      permalink,
+      previous,
+      next,
+      image,
+      keywords,
+    } = categoryGeneratedIndex;
 
     const propFileName = slugs.slug(
       `${version.versionPath}-${categoryGeneratedIndex.sidebar}-category-${categoryGeneratedIndex.title}`,
@@ -42,6 +51,8 @@ export async function createCategoryGeneratedIndexRoutes({
       description,
       slug,
       permalink,
+      image,
+      keywords,
       navigation: {
         previous,
         next,

package/src/sidebars/types.ts

@@ -52,6 +52,8 @@ export type SidebarItemCategoryLinkGeneratedIndexConfig = {
   slug?: string;
   title?: string;
   description?: string;
+  image?: string;
+  keywords?: string | readonly string[];
 };
 export type SidebarItemCategoryLinkGeneratedIndex = {
   type: 'generated-index';
@@ -59,6 +61,8 @@ export type SidebarItemCategoryLinkGeneratedIndex = {
   permalink: string;
   title?: string;
   description?: string;
+  image?: string;
+  keywords?: string | readonly string[];
 };
 
 export type SidebarItemCategoryLinkConfig =

package/src/sidebars/validation.ts

@@ -70,6 +70,8 @@ const sidebarItemCategoryLinkSchema = Joi.object<SidebarItemCategoryLink>()
           // permalink: Joi.string().optional(), // No, this one is not in the user config, only in the normalized version
           title: Joi.string().optional(),
           description: Joi.string().optional(),
+          image: Joi.string().optional(),
+          keywords: [Joi.string(), Joi.array().items(Joi.string())],
         }),
       },
       {

package/src/types.ts

@@ -174,6 +174,8 @@ export type CategoryGeneratedIndexMetadata = {
   sidebar: string;
   previous?: DocNavLink;
   next?: DocNavLink;
+  image?: string;
+  keywords?: string | readonly string[];
 };
 
 export type SourceToPermalink = {