3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-13 17:17:28 +02:00
Code Issues Projects Releases Packages Wiki Activity

feat(content-docs): allow SEO metadata for category index pages (#6239)

Browse source
This commit is contained in:
Joshua Chen 2022-01-06 18:31:01 +08:00 • committed by GitHub
parent e1d1618039
commit 3cb99124de
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 31 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

2
packages/docusaurus-plugin-content-docs/src/categoryGeneratedIndex.ts
View file

@ -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,

2
packages/docusaurus-plugin-content-docs/src/plugin-content-docs.d.ts vendored
View file

@ -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;

15
packages/docusaurus-plugin-content-docs/src/routes.ts
View file

@ -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,

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

@ -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 =

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

@ -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())],
}),
},
{

2
packages/docusaurus-plugin-content-docs/src/types.ts
View file

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