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.

Sign up for GitHub

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

Fix title_meta handling in doc front matter #10879

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix title_meta handling in doc front matter #10879

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
81caba5
fix: ensure `title_meta` in doc front matter is applied
MisterFISHUP Jan 29, 2025
c6c3cc6
test: correct prefix in `validateBlogPostFrontMatter sidebar_label` test
MisterFISHUP Jan 29, 2025
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
2 changes: 1 addition & 1 deletion packages/docusaurus-plugin-content-blog/src/__tests__/frontMatter.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ describe('validateBlogPostFrontMatter title_meta', () => {

describe('validateBlogPostFrontMatter sidebar_label', () => {
testField({
prefix: 'title_meta',
prefix: 'sidebar_label',
validFrontMatters: [
{sidebar_label: undefined},
{sidebar_label: ''},
Expand Down
15 changes: 15 additions & 0 deletions packages/docusaurus-plugin-content-docs/src/__tests__/frontMatter.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,21 @@ describe('validateDocFrontMatter title', () => {
});
});

describe('validateDocFrontMatter title_meta', () => {
testField({
prefix: 'title_meta',
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('validateDocFrontMatter hide_title', () => {
testField({
prefix: 'hide_title',
Expand Down
1 change: 1 addition & 0 deletions packages/docusaurus-plugin-content-docs/src/frontMatter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ export const DocFrontMatterSchema = Joi.object<DocFrontMatter>({
id: Joi.string(),
// See https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
title: Joi.string().allow(''),
title_meta: Joi.string().allow(''),
hide_title: Joi.boolean(),
hide_table_of_contents: Joi.boolean(),
keywords: Joi.array().items(Joi.string().required()),
Expand Down
4 changes: 4 additions & 0 deletions packages/docusaurus-plugin-content-docs/src/plugin-content-docs.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,10 @@ declare module '@docusaurus/plugin-content-docs' {
* @see {@link DocMetadata.title}
*/
title?: string;
/**
* Will be used for SEO page metadata and override DocMetadata.title.
*/
title_meta?: string;
/**
* Front matter tags, unnormalized.
* @see {@link DocMetadata.tags}
Expand Down
2 changes: 1 addition & 1 deletion packages/docusaurus-theme-classic/src/theme/DocItem/Metadata/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export default function DocItemMetadata(): ReactNode {
const {metadata, frontMatter, assets} = useDoc();
return (
<PageMetadata
title={metadata.title}
title={frontMatter.title_meta ?? metadata.title}
description={metadata.description}
keywords={frontMatter.keywords}
image={assets.image ?? frontMatter.image}
Expand Down
Loading