@docusaurus/plugin-content-blog 3.6.3-canary-6163 → 3.6.3-canary-6167

package/lib/client/contexts.d.ts

@@ -22,7 +22,7 @@ export declare function BlogPostProvider({ children, content, isBlogPostPage, }:
     children: ReactNode;
     content: PropBlogPostContent;
     isBlogPostPage?: boolean;
-}): JSX.Element;
+}): ReactNode;
 /**
  * Returns the data of the currently browsed blog post. Gives access to
  * front matter, metadata, TOC, etc.

package/lib/frontMatter.js

@@ -23,7 +23,8 @@ const FrontMatterAuthorErrorMessage = '{{#label}} does not look like a valid blo
 const BlogFrontMatterSchema = utils_validation_1.JoiFrontMatter.object({
     id: utils_validation_1.JoiFrontMatter.string(),
     title: utils_validation_1.JoiFrontMatter.string().allow(''),
-    title_meta: utils_validation_1.JoiFrontMatter.string(),
+    title_meta: utils_validation_1.JoiFrontMatter.string().allow(''),
+    sidebar_label: utils_validation_1.JoiFrontMatter.string().allow(''),
     description: utils_validation_1.JoiFrontMatter.string().allow(''),
     tags: utils_validation_1.FrontMatterTagsSchema,
     date: utils_validation_1.JoiFrontMatter.date().raw(),

package/lib/props.js

@@ -34,7 +34,7 @@ function toBlogSidebarProp({ blogSidebarTitle, blogPosts, }) {
     return {
         title: blogSidebarTitle,
         items: blogPosts.map((blogPost) => ({
-            title: blogPost.metadata.title,
+            title: blogPost.metadata.frontMatter.sidebar_label ?? blogPost.metadata.title,
             permalink: blogPost.metadata.permalink,
             unlisted: blogPost.metadata.unlisted,
             date: blogPost.metadata.date,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "3.6.3-canary-6163",
+  "version": "3.6.3-canary-6167",
   "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-blog.d.ts",
@@ -31,14 +31,14 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "3.6.3-canary-6163",
-    "@docusaurus/logger": "3.6.3-canary-6163",
-    "@docusaurus/mdx-loader": "3.6.3-canary-6163",
-    "@docusaurus/theme-common": "3.6.3-canary-6163",
-    "@docusaurus/types": "3.6.3-canary-6163",
-    "@docusaurus/utils": "3.6.3-canary-6163",
-    "@docusaurus/utils-common": "3.6.3-canary-6163",
-    "@docusaurus/utils-validation": "3.6.3-canary-6163",
+    "@docusaurus/core": "3.6.3-canary-6167",
+    "@docusaurus/logger": "3.6.3-canary-6167",
+    "@docusaurus/mdx-loader": "3.6.3-canary-6167",
+    "@docusaurus/theme-common": "3.6.3-canary-6167",
+    "@docusaurus/types": "3.6.3-canary-6167",
+    "@docusaurus/utils": "3.6.3-canary-6167",
+    "@docusaurus/utils-common": "3.6.3-canary-6167",
+    "@docusaurus/utils-validation": "3.6.3-canary-6167",
     "cheerio": "1.0.0-rc.12",
     "feed": "^4.2.2",
     "fs-extra": "^11.1.1",
@@ -62,5 +62,5 @@
     "@total-typescript/shoehorn": "^0.1.2",
     "tree-node-cli": "^1.6.0"
   },
-  "gitHead": "b1e107c7975d2f83bd49b4d04c9b4e594c3c7b54"
+  "gitHead": "d8c53eaab293c71917973e7358a894572141e1c8"
 }

package/src/client/contexts.tsx

@@ -74,7 +74,7 @@ export function BlogPostProvider({
   children: ReactNode;
   content: PropBlogPostContent;
   isBlogPostPage?: boolean;
-}): JSX.Element {
+}): ReactNode {
   const contextValue = useContextValue({content, isBlogPostPage});
   return <Context.Provider value={contextValue}>{children}</Context.Provider>;
 }

package/src/frontMatter.ts

@@ -33,7 +33,8 @@ const FrontMatterAuthorErrorMessage =
 const BlogFrontMatterSchema = Joi.object<BlogPostFrontMatter>({
   id: Joi.string(),
   title: Joi.string().allow(''),
-  title_meta: Joi.string(),
+  title_meta: Joi.string().allow(''),
+  sidebar_label: Joi.string().allow(''),
   description: Joi.string().allow(''),
   tags: FrontMatterTagsSchema,
   date: Joi.date().raw(),

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

@@ -145,7 +145,6 @@ declare module '@docusaurus/plugin-content-blog' {
     title?: string;
     /**
      * Will be used for SEO page metadata and override BlogPostMetadata.title.
-     * @see {@link BlogPostMetadata.title_meta}
      */
     title_meta?: string;
     /**
@@ -153,6 +152,10 @@ declare module '@docusaurus/plugin-content-blog' {
      * @see {@link BlogPostMetadata.description}
      */
     description?: string;
+    /**
+     * Will override the default excerpt.
+     */
+    sidebar_label?: string;
     /**
      * Front matter tags, unnormalized.
      * @see {@link BlogPostMetadata.tags}
@@ -660,6 +663,7 @@ declare module '@docusaurus/plugin-content-blog' {
 }
 
 declare module '@theme/BlogPostPage' {
+  import type {ReactNode} from 'react';
   import type {
     BlogPostFrontMatter,
     BlogSidebar,
@@ -680,18 +684,23 @@ declare module '@theme/BlogPostPage' {
     readonly blogMetadata: BlogMetadata;
   }
 
-  export default function BlogPostPage(props: Props): JSX.Element;
+  export default function BlogPostPage(props: Props): ReactNode;
 }
 
 declare module '@theme/BlogPostPage/Metadata' {
-  export default function BlogPostPageMetadata(): JSX.Element;
+  import type {ReactNode} from 'react';
+
+  export default function BlogPostPageMetadata(): ReactNode;
 }
 
 declare module '@theme/BlogPostPage/StructuredData' {
-  export default function BlogPostStructuredData(): JSX.Element;
+  import type {ReactNode} from 'react';
+
+  export default function BlogPostStructuredData(): ReactNode;
 }
 
 declare module '@theme/BlogListPage' {
+  import type {ReactNode} from 'react';
   import type {Content} from '@theme/BlogPostPage';
   import type {
     BlogSidebar,
@@ -710,10 +719,11 @@ declare module '@theme/BlogListPage' {
     readonly items: readonly {readonly content: Content}[];
   }
 
-  export default function BlogListPage(props: Props): JSX.Element;
+  export default function BlogListPage(props: Props): ReactNode;
 }
 
 declare module '@theme/BlogListPage/StructuredData' {
+  import type {ReactNode} from 'react';
   import type {Content} from '@theme/BlogPostPage';
   import type {
     BlogSidebar,
@@ -732,10 +742,11 @@ declare module '@theme/BlogListPage/StructuredData' {
     readonly items: readonly {readonly content: Content}[];
   }
 
-  export default function BlogListPageStructuredData(props: Props): JSX.Element;
+  export default function BlogListPageStructuredData(props: Props): ReactNode;
 }
 
 declare module '@theme/BlogTagsListPage' {
+  import type {ReactNode} from 'react';
   import type {BlogSidebar} from '@docusaurus/plugin-content-blog';
   import type {TagsListItem} from '@docusaurus/utils';
 
@@ -746,10 +757,11 @@ declare module '@theme/BlogTagsListPage' {
     readonly tags: TagsListItem[];
   }
 
-  export default function BlogTagsListPage(props: Props): JSX.Element;
+  export default function BlogTagsListPage(props: Props): ReactNode;
 }
 
 declare module '@theme/Blog/Pages/BlogAuthorsListPage' {
+  import type {ReactNode} from 'react';
   import type {
     AuthorItemProp,
     BlogSidebar,
@@ -762,10 +774,11 @@ declare module '@theme/Blog/Pages/BlogAuthorsListPage' {
     readonly authors: AuthorItemProp[];
   }
 
-  export default function BlogAuthorsListPage(props: Props): JSX.Element;
+  export default function BlogAuthorsListPage(props: Props): ReactNode;
 }
 
 declare module '@theme/Blog/Pages/BlogAuthorsPostsPage' {
+  import type {ReactNode} from 'react';
   import type {Content} from '@theme/BlogPostPage';
   import type {
     AuthorItemProp,
@@ -787,10 +800,11 @@ declare module '@theme/Blog/Pages/BlogAuthorsPostsPage' {
     readonly items: readonly {readonly content: Content}[];
   }
 
-  export default function BlogAuthorsPostsPage(props: Props): JSX.Element;
+  export default function BlogAuthorsPostsPage(props: Props): ReactNode;
 }
 
 declare module '@theme/BlogTagsPostsPage' {
+  import type {ReactNode} from 'react';
   import type {Content} from '@theme/BlogPostPage';
   import type {
     BlogSidebar,
@@ -812,10 +826,11 @@ declare module '@theme/BlogTagsPostsPage' {
     readonly items: readonly {readonly content: Content}[];
   }
 
-  export default function BlogTagsPostsPage(props: Props): JSX.Element;
+  export default function BlogTagsPostsPage(props: Props): ReactNode;
 }
 
 declare module '@theme/BlogArchivePage' {
+  import type {ReactNode} from 'react';
   import type {Content} from '@theme/BlogPostPage';
 
   /** We may add extra metadata or prune some metadata from here */
@@ -829,5 +844,5 @@ declare module '@theme/BlogArchivePage' {
     };
   }
 
-  export default function BlogArchivePage(props: Props): JSX.Element;
+  export default function BlogArchivePage(props: Props): ReactNode;
 }

package/src/props.ts

@@ -65,7 +65,8 @@ export function toBlogSidebarProp({
   return {
     title: blogSidebarTitle,
     items: blogPosts.map((blogPost) => ({
-      title: blogPost.metadata.title,
+      title:
+        blogPost.metadata.frontMatter.sidebar_label ?? blogPost.metadata.title,
       permalink: blogPost.metadata.permalink,
       unlisted: blogPost.metadata.unlisted,
       date: blogPost.metadata.date,