3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-07-26 21:18:47 +02:00
Code Issues Projects Releases Packages Wiki Activity

feat(pages): add support for missing SEO front matter + improve SEO docs (#9071)

Browse source 
Co-authored-by: Thad Guidry <thadguidry@gmail.com>
This commit is contained in:
Sébastien Lorber 2023-06-15 16:07:00 +02:00 • committed by GitHub
parent 117cbac702
commit 9866af7f44
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 146 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

15
packages/docusaurus-plugin-content-pages/src/frontMatter.ts
View file

@ -10,12 +10,17 @@ import {
validateFrontMatter,
FrontMatterTOCHeadingLevels,
ContentVisibilitySchema,
URISchema,
} from '@docusaurus/utils-validation';
import type {FrontMatter} from '@docusaurus/plugin-content-pages';
import type {PageFrontMatter} from '@docusaurus/plugin-content-pages';
const PageFrontMatterSchema = Joi.object<FrontMatter>({
title: Joi.string(),
description: Joi.string(),
const PageFrontMatterSchema = Joi.object<PageFrontMatter>({
// See https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
title: Joi.string().allow(''),
// See https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
description: Joi.string().allow(''),
keywords: Joi.array().items(Joi.string().required()),
image: URISchema,
wrapperClassName: Joi.string(),
hide_table_of_contents: Joi.boolean(),
...FrontMatterTOCHeadingLevels,
@ -23,6 +28,6 @@ const PageFrontMatterSchema = Joi.object<FrontMatter>({
export function validatePageFrontMatter(frontMatter: {
[key: string]: unknown;
}): FrontMatter {
}): PageFrontMatter {
return validateFrontMatter(frontMatter, PageFrontMatterSchema);
}