mirror of
https://github.com/facebook/docusaurus.git
synced 2025-06-10 14:52:29 +02:00
51 lines
1.8 KiB
TypeScript
51 lines
1.8 KiB
TypeScript
/**
|
|
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*/
|
|
|
|
import {
|
|
JoiFrontMatter as Joi, // Custom instance for front matter
|
|
URISchema,
|
|
FrontMatterTagsSchema,
|
|
FrontMatterTOCHeadingLevels,
|
|
validateFrontMatter,
|
|
} from '@docusaurus/utils-validation';
|
|
import type {DocFrontMatter} from '@docusaurus/plugin-content-docs';
|
|
|
|
// NOTE: we don't add any default value on purpose here
|
|
// We don't want default values to magically appear in doc metadata and props
|
|
// While the user did not provide those values explicitly
|
|
// We use default values in code instead
|
|
const DocFrontMatterSchema = Joi.object<DocFrontMatter>({
|
|
id: Joi.string(),
|
|
// See https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
|
|
title: Joi.string().allow(''),
|
|
hide_title: Joi.boolean(),
|
|
hide_table_of_contents: Joi.boolean(),
|
|
keywords: Joi.array().items(Joi.string().required()),
|
|
image: URISchema,
|
|
// See https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
|
|
description: Joi.string().allow(''),
|
|
slug: Joi.string(),
|
|
sidebar_label: Joi.string(),
|
|
sidebar_position: Joi.number(),
|
|
sidebar_class_name: Joi.string(),
|
|
sidebar_custom_props: Joi.object().unknown(),
|
|
displayed_sidebar: Joi.string().allow(null),
|
|
tags: FrontMatterTagsSchema,
|
|
pagination_label: Joi.string(),
|
|
custom_edit_url: URISchema.allow('', null),
|
|
parse_number_prefixes: Joi.boolean(),
|
|
pagination_next: Joi.string().allow(null),
|
|
pagination_prev: Joi.string().allow(null),
|
|
draft: Joi.boolean(),
|
|
...FrontMatterTOCHeadingLevels,
|
|
}).unknown();
|
|
|
|
export function validateDocFrontMatter(frontMatter: {
|
|
[key: string]: unknown;
|
|
}): DocFrontMatter {
|
|
return validateFrontMatter(frontMatter, DocFrontMatterSchema);
|
|
}
|