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

feat(v2): include frontmatter in loadedContent doc metadatas (#4495)

Browse source 
* feat: include frontmatter in globals

* feat: include frontmatter in globals (options schema test)

* feat(v2): document frontmatter in document metadata

* feat(v2): frontmatter in metadata, tests updated

* Update packages/docusaurus-plugin-content-docs/src/types.ts

* Update packages/docusaurus-plugin-content-docs/src/types.ts

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
This commit is contained in:
Chris Kanich 2021-03-26 13:54:29 -05:00 • committed by GitHub
parent 9715048f79
commit b10ed6cb00
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 192 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

143
packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/index.test.ts.snap
View file

@ -152,6 +152,11 @@ Object {
\\"slug\\": \\"/foo/bar\\",
\\"permalink\\": \\"/docs/foo/bar\\",
\\"version\\": \\"current\\",
\\"frontMatter\\": {
\\"id\\": \\"bar\\",
\\"title\\": \\"Bar\\",
\\"description\\": \\"This is custom description\\"
},
\\"sidebar\\": \\"docs\\",
\\"next\\": {
\\"title\\": \\"baz\\",
@ -168,6 +173,11 @@ Object {
\\"slug\\": \\"/foo/bazSlug.html\\",
\\"permalink\\": \\"/docs/foo/bazSlug.html\\",
\\"version\\": \\"current\\",
\\"frontMatter\\": {
\\"id\\": \\"baz\\",
\\"title\\": \\"baz\\",
\\"slug\\": \\"bazSlug.html\\"
},
\\"sidebar\\": \\"docs\\",
\\"previous\\": {
\\"title\\": \\"Bar\\",
@ -187,7 +197,10 @@ Object {
\\"source\\": \\"@site/docs/headingAsTitle.md\\",
\\"slug\\": \\"/headingAsTitle\\",
\\"permalink\\": \\"/docs/headingAsTitle\\",
\\"version\\": \\"current\\"
\\"version\\": \\"current\\",
\\"frontMatter\\": {
\\"title\\": \\"My heading as title\\"
}
}",
"site-docs-hello-md-9df.json": "{
\\"unversionedId\\": \\"hello\\",
@ -199,6 +212,10 @@ Object {
\\"slug\\": \\"/\\",
\\"permalink\\": \\"/docs/\\",
\\"version\\": \\"current\\",
\\"frontMatter\\": {
\\"id\\": \\"hello\\",
\\"title\\": \\"Hello, World !\\"
},
\\"sidebar\\": \\"docs\\",
\\"previous\\": {
\\"title\\": \\"baz\\",
@ -215,7 +232,10 @@ Object {
\\"slug\\": \\"/ipsum\\",
\\"permalink\\": \\"/docs/ipsum\\",
\\"editUrl\\": null,
\\"version\\": \\"current\\"
\\"version\\": \\"current\\",
\\"frontMatter\\": {
\\"custom_edit_url\\": null
}
}",
"site-docs-lorem-md-b27.json": "{
\\"unversionedId\\": \\"lorem\\",
@ -227,7 +247,11 @@ Object {
\\"slug\\": \\"/lorem\\",
\\"permalink\\": \\"/docs/lorem\\",
\\"editUrl\\": \\"https://github.com/customUrl/docs/lorem.md\\",
\\"version\\": \\"current\\"
\\"version\\": \\"current\\",
\\"frontMatter\\": {
\\"custom_edit_url\\": \\"https://github.com/customUrl/docs/lorem.md\\",
\\"unrelated_frontmatter\\": \\"won't be part of metadata\\"
}
}",
"site-docs-root-absolute-slug-md-db5.json": "{
\\"unversionedId\\": \\"rootAbsoluteSlug\\",
@ -238,7 +262,10 @@ Object {
\\"source\\": \\"@site/docs/rootAbsoluteSlug.md\\",
\\"slug\\": \\"/rootAbsoluteSlug\\",
\\"permalink\\": \\"/docs/rootAbsoluteSlug\\",
\\"version\\": \\"current\\"
\\"version\\": \\"current\\",
\\"frontMatter\\": {
\\"slug\\": \\"/rootAbsoluteSlug\\"
}
}",
"site-docs-root-relative-slug-md-3dd.json": "{
\\"unversionedId\\": \\"rootRelativeSlug\\",
@ -249,7 +276,10 @@ Object {
\\"source\\": \\"@site/docs/rootRelativeSlug.md\\",
\\"slug\\": \\"/rootRelativeSlug\\",
\\"permalink\\": \\"/docs/rootRelativeSlug\\",
\\"version\\": \\"current\\"
\\"version\\": \\"current\\",
\\"frontMatter\\": {
\\"slug\\": \\"rootRelativeSlug\\"
}
}",
"site-docs-root-resolved-slug-md-4d1.json": "{
\\"unversionedId\\": \\"rootResolvedSlug\\",
@ -260,7 +290,10 @@ Object {
\\"source\\": \\"@site/docs/rootResolvedSlug.md\\",
\\"slug\\": \\"/hey/rootResolvedSlug\\",
\\"permalink\\": \\"/docs/hey/rootResolvedSlug\\",
\\"version\\": \\"current\\"
\\"version\\": \\"current\\",
\\"frontMatter\\": {
\\"slug\\": \\"./hey/ho/../rootResolvedSlug\\"
}
}",
"site-docs-root-try-to-escape-slug-md-9ee.json": "{
\\"unversionedId\\": \\"rootTryToEscapeSlug\\",
@ -271,7 +304,10 @@ Object {
\\"source\\": \\"@site/docs/rootTryToEscapeSlug.md\\",
\\"slug\\": \\"/rootTryToEscapeSlug\\",
\\"permalink\\": \\"/docs/rootTryToEscapeSlug\\",
\\"version\\": \\"current\\"
\\"version\\": \\"current\\",
\\"frontMatter\\": {
\\"slug\\": \\"../../../../../../../../rootTryToEscapeSlug\\"
}
}",
"site-docs-slugs-absolute-slug-md-4e8.json": "{
\\"unversionedId\\": \\"slugs/absoluteSlug\\",
@ -282,7 +318,10 @@ Object {
\\"source\\": \\"@site/docs/slugs/absoluteSlug.md\\",
\\"slug\\": \\"/absoluteSlug\\",
\\"permalink\\": \\"/docs/absoluteSlug\\",
\\"version\\": \\"current\\"
\\"version\\": \\"current\\",
\\"frontMatter\\": {
\\"slug\\": \\"/absoluteSlug\\"
}
}",
"site-docs-slugs-relative-slug-md-d1c.json": "{
\\"unversionedId\\": \\"slugs/relativeSlug\\",
@ -293,7 +332,10 @@ Object {
\\"source\\": \\"@site/docs/slugs/relativeSlug.md\\",
\\"slug\\": \\"/slugs/relativeSlug\\",
\\"permalink\\": \\"/docs/slugs/relativeSlug\\",
\\"version\\": \\"current\\"
\\"version\\": \\"current\\",
\\"frontMatter\\": {
\\"slug\\": \\"relativeSlug\\"
}
}",
"site-docs-slugs-resolved-slug-md-02b.json": "{
\\"unversionedId\\": \\"slugs/resolvedSlug\\",
@ -304,7 +346,10 @@ Object {
\\"source\\": \\"@site/docs/slugs/resolvedSlug.md\\",
\\"slug\\": \\"/slugs/hey/resolvedSlug\\",
\\"permalink\\": \\"/docs/slugs/hey/resolvedSlug\\",
\\"version\\": \\"current\\"
\\"version\\": \\"current\\",
\\"frontMatter\\": {
\\"slug\\": \\"./hey/ho/../resolvedSlug\\"
}
}",
"site-docs-slugs-try-to-escape-slug-md-70d.json": "{
\\"unversionedId\\": \\"slugs/tryToEscapeSlug\\",
@ -315,7 +360,10 @@ Object {
\\"source\\": \\"@site/docs/slugs/tryToEscapeSlug.md\\",
\\"slug\\": \\"/tryToEscapeSlug\\",
\\"permalink\\": \\"/docs/tryToEscapeSlug\\",
\\"version\\": \\"current\\"
\\"version\\": \\"current\\",
\\"frontMatter\\": {
\\"slug\\": \\"../../../../../../../../tryToEscapeSlug\\"
}
}",
"version-current-metadata-prop-751.json": "{
\\"pluginId\\": \\"default\\",
@ -656,6 +704,7 @@ Object {
\\"slug\\": \\"/team\\",
\\"permalink\\": \\"/community/team\\",
\\"version\\": \\"1.0.0\\",
\\"frontMatter\\": {},
\\"sidebar\\": \\"version-1.0.0/community\\"
}",
"site-i-18-n-en-docusaurus-plugin-content-docs-community-current-team-md-7e5.json": "{
@ -668,6 +717,9 @@ Object {
\\"slug\\": \\"/team\\",
\\"permalink\\": \\"/community/next/team\\",
\\"version\\": \\"current\\",
\\"frontMatter\\": {
\\"title\\": \\"Team title translated\\"
},
\\"sidebar\\": \\"community\\"
}",
"version-1-0-0-metadata-prop-608.json": "{
@ -895,6 +947,9 @@ Object {
\\"slug\\": \\"/foo/barSlug\\",
\\"permalink\\": \\"/docs/next/foo/barSlug\\",
\\"version\\": \\"current\\",
\\"frontMatter\\": {
\\"slug\\": \\"barSlug\\"
},
\\"sidebar\\": \\"docs\\",
\\"next\\": {
\\"title\\": \\"hello\\",
@ -911,6 +966,7 @@ Object {
\\"slug\\": \\"/\\",
\\"permalink\\": \\"/docs/next/\\",
\\"version\\": \\"current\\",
\\"frontMatter\\": {},
\\"sidebar\\": \\"docs\\",
\\"previous\\": {
\\"title\\": \\"bar\\",
@ -926,7 +982,10 @@ Object {
\\"source\\": \\"@site/docs/slugs/absoluteSlug.md\\",
\\"slug\\": \\"/absoluteSlug\\",
\\"permalink\\": \\"/docs/next/absoluteSlug\\",
\\"version\\": \\"current\\"
\\"version\\": \\"current\\",
\\"frontMatter\\": {
\\"slug\\": \\"/absoluteSlug\\"
}
}",
"site-docs-slugs-relative-slug-md-d1c.json": "{
\\"unversionedId\\": \\"slugs/relativeSlug\\",
@ -937,7 +996,10 @@ Object {
\\"source\\": \\"@site/docs/slugs/relativeSlug.md\\",
\\"slug\\": \\"/slugs/relativeSlug\\",
\\"permalink\\": \\"/docs/next/slugs/relativeSlug\\",
\\"version\\": \\"current\\"
\\"version\\": \\"current\\",
\\"frontMatter\\": {
\\"slug\\": \\"relativeSlug\\"
}
}",
"site-docs-slugs-resolved-slug-md-02b.json": "{
\\"unversionedId\\": \\"slugs/resolvedSlug\\",
@ -948,7 +1010,10 @@ Object {
\\"source\\": \\"@site/docs/slugs/resolvedSlug.md\\",
\\"slug\\": \\"/slugs/hey/resolvedSlug\\",
\\"permalink\\": \\"/docs/next/slugs/hey/resolvedSlug\\",
\\"version\\": \\"current\\"
\\"version\\": \\"current\\",
\\"frontMatter\\": {
\\"slug\\": \\"./hey/ho/../resolvedSlug\\"
}
}",
"site-docs-slugs-try-to-escape-slug-md-70d.json": "{
\\"unversionedId\\": \\"slugs/tryToEscapeSlug\\",
@ -959,7 +1024,10 @@ Object {
\\"source\\": \\"@site/docs/slugs/tryToEscapeSlug.md\\",
\\"slug\\": \\"/tryToEscapeSlug\\",
\\"permalink\\": \\"/docs/next/tryToEscapeSlug\\",
\\"version\\": \\"current\\"
\\"version\\": \\"current\\",
\\"frontMatter\\": {
\\"slug\\": \\"../../../../../../../../tryToEscapeSlug\\"
}
}",
"site-i-18-n-en-docusaurus-plugin-content-docs-version-1-0-0-hello-md-fe5.json": "{
\\"unversionedId\\": \\"hello\\",
@ -971,6 +1039,7 @@ Object {
\\"slug\\": \\"/\\",
\\"permalink\\": \\"/docs/1.0.0/\\",
\\"version\\": \\"1.0.0\\",
\\"frontMatter\\": {},
\\"sidebar\\": \\"version-1.0.0/docs\\",
\\"previous\\": {
\\"title\\": \\"baz\\",
@ -987,6 +1056,9 @@ Object {
\\"slug\\": \\"/foo/barSlug\\",
\\"permalink\\": \\"/docs/1.0.0/foo/barSlug\\",
\\"version\\": \\"1.0.0\\",
\\"frontMatter\\": {
\\"slug\\": \\"barSlug\\"
},
\\"sidebar\\": \\"version-1.0.0/docs\\",
\\"next\\": {
\\"title\\": \\"baz\\",
@ -1003,6 +1075,7 @@ Object {
\\"slug\\": \\"/foo/baz\\",
\\"permalink\\": \\"/docs/1.0.0/foo/baz\\",
\\"version\\": \\"1.0.0\\",
\\"frontMatter\\": {},
\\"sidebar\\": \\"version-1.0.0/docs\\",
\\"previous\\": {
\\"title\\": \\"bar\\",
@ -1023,6 +1096,7 @@ Object {
\\"slug\\": \\"/foo/bar\\",
\\"permalink\\": \\"/docs/foo/bar\\",
\\"version\\": \\"1.0.1\\",
\\"frontMatter\\": {},
\\"sidebar\\": \\"version-1.0.1/docs\\",
\\"next\\": {
\\"title\\": \\"hello\\",
@ -1039,6 +1113,7 @@ Object {
\\"slug\\": \\"/\\",
\\"permalink\\": \\"/docs/\\",
\\"version\\": \\"1.0.1\\",
\\"frontMatter\\": {},
\\"sidebar\\": \\"version-1.0.1/docs\\",
\\"previous\\": {
\\"title\\": \\"bar\\",
@ -1055,6 +1130,9 @@ Object {
\\"slug\\": \\"/rootAbsoluteSlug\\",
\\"permalink\\": \\"/docs/withSlugs/rootAbsoluteSlug\\",
\\"version\\": \\"withSlugs\\",
\\"frontMatter\\": {
\\"slug\\": \\"/rootAbsoluteSlug\\"
},
\\"sidebar\\": \\"version-1.0.1/docs\\"
}",
"site-versioned-docs-version-with-slugs-root-relative-slug-md-32a.json": "{
@ -1066,7 +1144,10 @@ Object {
\\"source\\": \\"@site/versioned_docs/version-withSlugs/rootRelativeSlug.md\\",
\\"slug\\": \\"/rootRelativeSlug\\",
\\"permalink\\": \\"/docs/withSlugs/rootRelativeSlug\\",
\\"version\\": \\"withSlugs\\"
\\"version\\": \\"withSlugs\\",
\\"frontMatter\\": {
\\"slug\\": \\"rootRelativeSlug\\"
}
}",
"site-versioned-docs-version-with-slugs-root-resolved-slug-md-aee.json": "{
\\"unversionedId\\": \\"rootResolvedSlug\\",
@ -1077,7 +1158,10 @@ Object {
\\"source\\": \\"@site/versioned_docs/version-withSlugs/rootResolvedSlug.md\\",
\\"slug\\": \\"/hey/rootResolvedSlug\\",
\\"permalink\\": \\"/docs/withSlugs/hey/rootResolvedSlug\\",
\\"version\\": \\"withSlugs\\"
\\"version\\": \\"withSlugs\\",
\\"frontMatter\\": {
\\"slug\\": \\"./hey/ho/../rootResolvedSlug\\"
}
}",
"site-versioned-docs-version-with-slugs-root-try-to-escape-slug-md-b5d.json": "{
\\"unversionedId\\": \\"rootTryToEscapeSlug\\",
@ -1088,7 +1172,10 @@ Object {
\\"source\\": \\"@site/versioned_docs/version-withSlugs/rootTryToEscapeSlug.md\\",
\\"slug\\": \\"/rootTryToEscapeSlug\\",
\\"permalink\\": \\"/docs/withSlugs/rootTryToEscapeSlug\\",
\\"version\\": \\"withSlugs\\"
\\"version\\": \\"withSlugs\\",
\\"frontMatter\\": {
\\"slug\\": \\"../../../../../../../../rootTryToEscapeSlug\\"
}
}",
"site-versioned-docs-version-with-slugs-slugs-absolute-slug-md-47a.json": "{
\\"unversionedId\\": \\"slugs/absoluteSlug\\",
@ -1099,7 +1186,10 @@ Object {
\\"source\\": \\"@site/versioned_docs/version-withSlugs/slugs/absoluteSlug.md\\",
\\"slug\\": \\"/absoluteSlug\\",
\\"permalink\\": \\"/docs/withSlugs/absoluteSlug\\",
\\"version\\": \\"withSlugs\\"
\\"version\\": \\"withSlugs\\",
\\"frontMatter\\": {
\\"slug\\": \\"/absoluteSlug\\"
}
}",
"site-versioned-docs-version-with-slugs-slugs-relative-slug-md-a95.json": "{
\\"unversionedId\\": \\"slugs/relativeSlug\\",
@ -1110,7 +1200,10 @@ Object {
\\"source\\": \\"@site/versioned_docs/version-withSlugs/slugs/relativeSlug.md\\",
\\"slug\\": \\"/slugs/relativeSlug\\",
\\"permalink\\": \\"/docs/withSlugs/slugs/relativeSlug\\",
\\"version\\": \\"withSlugs\\"
\\"version\\": \\"withSlugs\\",
\\"frontMatter\\": {
\\"slug\\": \\"relativeSlug\\"
}
}",
"site-versioned-docs-version-with-slugs-slugs-resolved-slug-md-5a1.json": "{
\\"unversionedId\\": \\"slugs/resolvedSlug\\",
@ -1121,7 +1214,10 @@ Object {
\\"source\\": \\"@site/versioned_docs/version-withSlugs/slugs/resolvedSlug.md\\",
\\"slug\\": \\"/slugs/hey/resolvedSlug\\",
\\"permalink\\": \\"/docs/withSlugs/slugs/hey/resolvedSlug\\",
\\"version\\": \\"withSlugs\\"
\\"version\\": \\"withSlugs\\",
\\"frontMatter\\": {
\\"slug\\": \\"./hey/ho/../resolvedSlug\\"
}
}",
"site-versioned-docs-version-with-slugs-slugs-try-to-escape-slug-md-4e1.json": "{
\\"unversionedId\\": \\"slugs/tryToEscapeSlug\\",
@ -1132,7 +1228,10 @@ Object {
\\"source\\": \\"@site/versioned_docs/version-withSlugs/slugs/tryToEscapeSlug.md\\",
\\"slug\\": \\"/tryToEscapeSlug\\",
\\"permalink\\": \\"/docs/withSlugs/tryToEscapeSlug\\",
\\"version\\": \\"withSlugs\\"
\\"version\\": \\"withSlugs\\",
\\"frontMatter\\": {
\\"slug\\": \\"../../../../../../../../tryToEscapeSlug\\"
}
}",
"version-1-0-0-metadata-prop-608.json": "{
\\"pluginId\\": \\"default\\",

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

@ -182,6 +182,11 @@ describe('simple site', () => {
slug: '/foo/bar',
title: 'Bar',
description: 'This is custom description',
frontMatter: {
description: 'This is custom description',
id: 'bar',
title: 'Bar',
},
});
await defaultTestUtils.testMeta(path.join('hello.md'), {
version: 'current',
@ -192,6 +197,10 @@ describe('simple site', () => {
slug: '/hello',
title: 'Hello, World !',
description: `Hi, Endilie here :)`,
frontMatter: {
id: 'hello',
title: 'Hello, World !',
},
});
});
@ -216,6 +225,10 @@ describe('simple site', () => {
slug: '/',
title: 'Hello, World !',
description: `Hi, Endilie here :)`,
frontMatter: {
id: 'hello',
title: 'Hello, World !',
},
});
});
@ -240,6 +253,11 @@ describe('simple site', () => {
slug: '/',
title: 'Bar',
description: 'This is custom description',
frontMatter: {
description: 'This is custom description',
id: 'bar',
title: 'Bar',
},
});
});
@ -268,6 +286,11 @@ describe('simple site', () => {
editUrl:
'https://github.com/facebook/docusaurus/edit/master/website/docs/foo/baz.md',
description: 'Images',
frontMatter: {
id: 'baz',
slug: 'bazSlug.html',
title: 'baz',
},
});
});
@ -284,6 +307,10 @@ describe('simple site', () => {
title: 'lorem',
editUrl: 'https://github.com/customUrl/docs/lorem.md',
description: 'Lorem ipsum.',
frontMatter: {
custom_edit_url: 'https://github.com/customUrl/docs/lorem.md',
unrelated_frontmatter: "won't be part of metadata",
},
});
});
@ -315,6 +342,11 @@ describe('simple site', () => {
title: 'baz',
editUrl: hardcodedEditUrl,
description: 'Images',
frontMatter: {
id: 'baz',
slug: 'bazSlug.html',
title: 'baz',
},
});
expect(editUrlFunction).toHaveBeenCalledTimes(1);
@ -352,6 +384,10 @@ describe('simple site', () => {
title: 'lorem',
editUrl: 'https://github.com/customUrl/docs/lorem.md',
description: 'Lorem ipsum.',
frontMatter: {
custom_edit_url: 'https://github.com/customUrl/docs/lorem.md',
unrelated_frontmatter: "won't be part of metadata",
},
lastUpdatedAt: 1539502055,
formattedLastUpdatedAt: '10/14/2018',
lastUpdatedBy: 'Author',
@ -518,6 +554,7 @@ describe('versioned site', () => {
slug: '/foo/barSlug',
title: 'bar',
description: 'This is next version of bar.',
frontMatter: {slug: 'barSlug'},
version: 'current',
});
await currentVersionTestUtils.testMeta(path.join('hello.md'), {
@ -528,6 +565,7 @@ describe('versioned site', () => {
slug: '/hello',
title: 'hello',
description: 'Hello next !',
frontMatter: {},
version: 'current',
});
});
@ -543,6 +581,7 @@ describe('versioned site', () => {
slug: '/foo/barSlug',
title: 'bar',
description: 'Bar 1.0.0 !',
frontMatter: {slug: 'barSlug'},
version: '1.0.0',
});
await version100TestUtils.testMeta(path.join('hello.md'), {
@ -553,6 +592,7 @@ describe('versioned site', () => {
slug: '/hello',
title: 'hello',
description: 'Hello 1.0.0 ! (translated en)',
frontMatter: {},
version: '1.0.0',
source:
'@site/i18n/en/docusaurus-plugin-content-docs/version-1.0.0/hello.md',
@ -566,6 +606,7 @@ describe('versioned site', () => {
title: 'bar',
description: 'Bar 1.0.1 !',
version: '1.0.1',
frontMatter: {},
});
await version101TestUtils.testMeta(path.join('hello.md'), {
id: 'version-1.0.1/hello',
@ -576,6 +617,7 @@ describe('versioned site', () => {
title: 'hello',
description: 'Hello 1.0.1 !',
version: '1.0.1',
frontMatter: {},
});
});
@ -664,6 +706,7 @@ describe('versioned site', () => {
slug: '/hello',
title: 'hello',
description: 'Hello 1.0.0 ! (translated en)',
frontMatter: {},
version: '1.0.0',
source:
'@site/i18n/en/docusaurus-plugin-content-docs/version-1.0.0/hello.md',
@ -703,6 +746,7 @@ describe('versioned site', () => {
slug: '/hello',
title: 'hello',
description: 'Hello 1.0.0 ! (translated en)',
frontMatter: {},
version: '1.0.0',
source:
'@site/i18n/en/docusaurus-plugin-content-docs/version-1.0.0/hello.md',
@ -734,6 +778,7 @@ describe('versioned site', () => {
slug: '/hello',
title: 'hello',
description: 'Hello 1.0.0 ! (translated en)',
frontMatter: {},
version: '1.0.0',
source:
'@site/i18n/en/docusaurus-plugin-content-docs/version-1.0.0/hello.md',
@ -766,6 +811,7 @@ describe('versioned site', () => {
slug: '/hello',
title: 'hello',
description: 'Hello 1.0.0 ! (translated fr)',
frontMatter: {},
version: '1.0.0',
source:
'@site/i18n/fr/docusaurus-plugin-content-docs/version-1.0.0/hello.md',
@ -799,6 +845,7 @@ describe('versioned site', () => {
slug: '/hello',
title: 'hello',
description: 'Hello 1.0.0 ! (translated fr)',
frontMatter: {},
version: '1.0.0',
source:
'@site/i18n/fr/docusaurus-plugin-content-docs/version-1.0.0/hello.md',

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

@ -262,6 +262,10 @@ describe('simple website', () => {
),
title: 'Hello, World !',
description: 'Hi, Endilie here :)',
frontMatter: {
id: 'hello',
title: 'Hello, World !',
},
});
expect(findDocById(currentVersion, 'foo/bar')).toEqual({
@ -285,6 +289,11 @@ describe('simple website', () => {
),
title: 'Bar',
description: 'This is custom description',
frontMatter: {
description: 'This is custom description',
id: 'bar',
title: 'Bar',
},
});
expect(currentVersion.sidebars).toMatchSnapshot();
@ -433,6 +442,9 @@ describe('versioned website', () => {
),
title: 'bar',
description: 'This is next version of bar.',
frontMatter: {
slug: 'barSlug',
},
version: 'current',
sidebar: 'docs',
next: {
@ -454,6 +466,7 @@ describe('versioned website', () => {
),
title: 'hello',
description: 'Hello next !',
frontMatter: {},
version: 'current',
sidebar: 'docs',
previous: {
@ -475,6 +488,7 @@ describe('versioned website', () => {
),
title: 'hello',
description: 'Hello 1.0.1 !',
frontMatter: {},
version: '1.0.1',
sidebar: 'version-1.0.1/docs',
previous: {
@ -498,6 +512,7 @@ describe('versioned website', () => {
title: 'baz',
description:
'Baz 1.0.0 ! This will be deleted in next subsequent versions.',
frontMatter: {},
version: '1.0.0',
sidebar: 'version-1.0.0/docs',
next: {
@ -642,6 +657,7 @@ describe('versioned website (community)', () => {
description: 'Team current version (translated)',
version: 'current',
sidebar: 'community',
frontMatter: {title: 'Team title translated'},
});
expect(findDocById(version100, 'team')).toEqual({
...defaultDocMetadata,
@ -659,6 +675,7 @@ describe('versioned website (community)', () => {
description: 'Team 1.0.0',
version: '1.0.0',
sidebar: 'version-1.0.0/community',
frontMatter: {},
});
expect(currentVersion.sidebars).toMatchSnapshot('current version sidebars');

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

@ -219,5 +219,6 @@ export function processDocMetadata({
)
: undefined,
sidebar_label: sidebarLabel,
frontMatter,
};
}

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

@ -130,6 +130,11 @@ export type LastUpdateData = {
lastUpdatedBy?: string;
};
export type FrontMatter = {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
[key: string]: any;
};
export type DocMetadataBase = LastUpdateData & {
version: VersionName;
unversionedId: string;
@ -143,6 +148,7 @@ export type DocMetadataBase = LastUpdateData & {
// eslint-disable-next-line camelcase
sidebar_label?: string;
editUrl?: string | null;
frontMatter: FrontMatter;
};
export type DocNavLink = {