feat(content-docs): add support for sidebar item category/link descriptions in generated index page

packages/docusaurus-plugin-content-docs/src/sidebars/types.ts

@@ -45,6 +45,7 @@ export type SidebarItemLink = SidebarItemBase & {
   href: string;
   label: string;
   autoAddBaseUrl?: boolean;
+  description?: string;
 };
 
 export type SidebarItemAutogenerated = SidebarItemBase & {
@@ -69,6 +70,7 @@ export type SidebarItemCategoryLinkGeneratedIndexConfig = {
   image?: string;
   keywords?: string | readonly string[];
 };
+
 export type SidebarItemCategoryLinkGeneratedIndex = {
   type: 'generated-index';
   slug: string;

packages/docusaurus-plugin-content-docs/src/sidebars/validation.ts

@@ -63,6 +63,9 @@ const sidebarItemLinkSchema = sidebarItemBaseSchema.append<SidebarItemLink>({
   label: Joi.string()
     .required()
     .messages({'any.unknown': '"label" must be a string'}),
+  description: Joi.string().optional().messages({
+    'any.unknown': '"description" must be a string',
+  }),
 });
 
 const sidebarItemCategoryLinkSchema = Joi.object<SidebarItemCategoryLink>()

packages/docusaurus-theme-classic/src/theme/DocCard/index.tsx

@@ -104,7 +104,9 @@ function CardLink({item}: {item: PropSidebarItemLink}): JSX.Element {
       href={item.href}
       icon={icon}
       title={item.label}
-      description={doc?.description}
+      description={
+        isInternalUrl(item.href) ? doc?.description : item.description
+      }
     />
   );
 }

website/_dogfooding/docs-tests-sidebars.js

@@ -39,6 +39,12 @@ const sidebars = {
           label: 'External Link test',
           href: 'https://docusaurus.io',
         },
+        {
+          type: 'link',
+          label: 'External Link with description',
+          href: 'https://docusaurus.io',
+          description: 'Some description',
+        },
       ],
     },
     {