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

refactor(v2): remove sidebar_label filed from doc metadata file (#4863)

Browse source
This commit is contained in:
Alexey Pyltsyn 2021-06-02 17:52:41 +03:00 • committed by GitHub
parent 644f148a8b
commit d72f760e4d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 6 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

3
packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts
View file

@ -76,7 +76,7 @@ function createTestUtils({
docFileSource: string,
expectedMetadata: Optional<
DocMetadataBase,
'source' | 'lastUpdatedBy' | 'lastUpdatedAt' | 'sidebar_label' | 'editUrl'
'source' | 'lastUpdatedBy' | 'lastUpdatedAt' | 'editUrl'
>,
) {
const docFile = await readDoc(docFileSource);
@ -89,7 +89,6 @@ function createTestUtils({
expect(metadata).toEqual({
lastUpdatedBy: undefined,
lastUpdatedAt: undefined,
sidebar_label: undefined,
editUrl: undefined,
source: path.posix.join(
'@site',

1
packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts
View file

@ -57,7 +57,6 @@ const defaultDocMetadata: Partial<DocMetadata> = {
editUrl: undefined,
lastUpdatedAt: undefined,
lastUpdatedBy: undefined,
sidebar_label: undefined,
formattedLastUpdatedAt: undefined,
};

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

@ -125,7 +125,6 @@ export function processDocMetadata({
const frontMatter = validateDocFrontMatter(unsafeFrontMatter);
const {
sidebar_label: sidebarLabel,
custom_edit_url: customEditURL,
// Strip number prefixes by default (01-MyFolder/01-MyDoc.md => MyFolder/MyDoc) by default,
@ -261,7 +260,6 @@ export function processDocMetadata({
lastUpdate.lastUpdatedAt * 1000,
)
: undefined,
sidebar_label: sidebarLabel,
sidebarPosition,
frontMatter,
};

6
packages/docusaurus-plugin-content-docs/src/props.ts
View file

@ -33,7 +33,11 @@ Available document ids=
);
}
const {title, permalink, sidebar_label: sidebarLabel} = docMetadata;
const {
title,
permalink,
frontMatter: {sidebar_label: sidebarLabel},
} = docMetadata;
return {
type: 'link',

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

@ -198,7 +198,6 @@ export type DocMetadataBase = LastUpdateData & {
slug: string;
permalink: string;
// eslint-disable-next-line camelcase
sidebar_label?: string;
sidebarPosition?: number;
editUrl?: string | null;
frontMatter: FrontMatter;