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

feat(content-docs): allow custom props through _category_.json (#6780)

Browse source 
* feat(content-docs): allow custom props through _category_.json

* refactor

* documentation

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
This commit is contained in:
tae 2022-03-05 19:52:36 +09:00 • committed by GitHub
parent b2d6e453e3
commit 2e163a9ec4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 18 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

10
packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/generator.test.ts
View file

@ -126,7 +126,12 @@ describe('DefaultSidebarItemsGenerator', () => {
contentPath: '',
},
categoriesMetadata: {
'02-Guides': {collapsed: false},
'02-Guides': {
collapsed: false,
customProps: {
description: 'foo',
},
},
'02-Guides/01-SubGuides': {
label: 'SubGuides (metadata file label)',
link: {
@ -230,6 +235,9 @@ describe('DefaultSidebarItemsGenerator', () => {
type: 'doc',
id: 'guides-index',
},
customProps: {
description: 'foo',
},
collapsed: false,
items: [
{type: 'doc', id: 'guide1', className: 'foo'},

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

@ -159,6 +159,7 @@ export const DefaultSidebarItemsGenerator: SidebarItemsGenerator = async ({
const categoryMetadata =
categoriesMetadata[posixPath(path.join(autogenDir, fullPath))];
const className = categoryMetadata?.className;
const customProps = categoryMetadata?.customProps;
const {filename, numberPrefix} = numberPrefixParser(folderName);
const allItems = Object.entries(dir).map(([key, content]) =>
dirToItem(content, key, `${fullPath}/${key}`),
@ -219,6 +220,7 @@ export const DefaultSidebarItemsGenerator: SidebarItemsGenerator = async ({
collapsed: categoryMetadata?.collapsed,
position: categoryMetadata?.position ?? numberPrefix,
source: folderName,
...(customProps !== undefined && {customProps}),
...(className !== undefined && {className}),
items,
...(link && {link}),

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

@ -216,6 +216,7 @@ export type CategoryMetadataFile = {
collapsible?: boolean;
className?: string;
link?: SidebarItemCategoryLinkConfig | null;
customProps?: Record<string, unknown>;
// TODO should we allow "items" here? how would this work? would an
// "autogenerated" type be allowed?

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

@ -164,6 +164,7 @@ const categoryMetadataFileSchema = Joi.object<CategoryMetadataFile>({
collapsible: Joi.boolean(),
className: Joi.string(),
link: sidebarItemCategoryLinkSchema,
customProps: Joi.object().unknown(),
});
export function validateCategoryMetadataFile(