Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(blog): Add frontMatter.sidebar_label #10729

Merged
merged 1 commit into from
Nov 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ describe('validateBlogPostFrontMatter description', () => {
prefix: 'description',
validFrontMatters: [
// See https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
{description: undefined},
{description: ''},
{description: 'description'},
],
Expand All @@ -90,6 +91,7 @@ describe('validateBlogPostFrontMatter title', () => {
prefix: 'title',
validFrontMatters: [
// See https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
{title: undefined},
{title: ''},
{title: 'title'},
],
Expand All @@ -103,14 +105,33 @@ describe('validateBlogPostFrontMatter title', () => {
describe('validateBlogPostFrontMatter title_meta', () => {
testField({
prefix: 'title_meta',
validFrontMatters: [{title: ''}, {title_meta: 'title'}],
validFrontMatters: [
{title_meta: undefined},
{title_meta: ''},
{title_meta: 'title'},
],
invalidFrontMatters: [
[{title_meta: null}, 'must be a string'],
[{title_meta: false}, 'must be a string'],
],
});
});

describe('validateBlogPostFrontMatter sidebar_label', () => {
testField({
prefix: 'title_meta',
validFrontMatters: [
{sidebar_label: undefined},
{sidebar_label: ''},
{sidebar_label: 'title'},
],
invalidFrontMatters: [
[{sidebar_label: null}, 'must be a string'],
[{sidebar_label: false}, 'must be a string'],
],
});
});

describe('validateBlogPostFrontMatter id', () => {
testField({
prefix: 'id',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ describe('toBlogSidebarProp', () => {
permalink: '/blog/blog-2',
unlisted: true,
date: '2024-01-01',
frontMatter: {hello: 'world'},
frontMatter: {hello: 'world', sidebar_label: 'title 2 (custom)'},
tags: [{label: 'tag1', permalink: '/tag1', inline: false}],
},
}),
Expand All @@ -117,7 +117,7 @@ describe('toBlogSidebarProp', () => {
{
"date": "2024-01-01",
"permalink": "/blog/blog-2",
"title": "title 2",
"title": "title 2 (custom)",
"unlisted": true,
},
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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(),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -145,14 +145,17 @@ 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;
/**
* Will override the default excerpt.
* @see {@link BlogPostMetadata.description}
*/
description?: string;
/**
* Will override the default excerpt.
*/
sidebar_label?: string;
/**
* Front matter tags, unnormalized.
* @see {@link BlogPostMetadata.tags}
Expand Down
3 changes: 2 additions & 1 deletion packages/docusaurus-plugin-content-blog/src/props.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
1 change: 1 addition & 0 deletions website/_dogfooding/_blog tests/2023-08-05.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Ensure heading anchor slugs respect GitHub emoji behavior
date: 2023-08-05
sidebar_label: 'Ensure heading... (custom label)'
---

## :smiley: This is a friendly header
Expand Down
1 change: 1 addition & 0 deletions website/docs/api/plugins/plugin-content-blog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,7 @@ Accepted fields:
| `author_image_url` | `string` | `undefined` | ⚠️ Prefer using `authors`. The URL to the author's thumbnail image. |
| `author_title` | `string` | `undefined` | ⚠️ Prefer using `authors`. A description of the author. |
| `title` | `string` | Markdown title | The blog post title. |
| `sidebar_label` | `string` | `title` | A custom label for the blog sidebar, replacing the default one (`title`). |
| `date` | `string` | File name or file creation time | The blog post creation date. If not specified, this can be extracted from the file or folder name, e.g, `2021-04-15-blog-post.mdx`, `2021-04-15-blog-post/index.mdx`, `2021/04/15/blog-post.mdx`. Otherwise, it is the Markdown file creation time. |
| `tags` | `Tag[]` | `undefined` | A list of strings or objects of two string fields `label` and `permalink` to tag to your post. Strings can be a reference to keys of a [tags file](#tags-file) (usually `tags.yml`) |
| `draft` | `boolean` | `false` | Draft blog posts will only be available during development. |
Expand Down