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

refactor(content-docs): read category metadata files before autogenerating (#6586)

Browse source 
* refactor(content-docs): read category metadata files before autogenerating

* fix tests

* fix Windows...

* warn user when behavior is undetermined

* oops

* fix typo
This commit is contained in:
Joshua Chen 2022-02-03 16:16:19 +08:00 • committed by GitHub
parent b03431f139
commit 1ca07f8466
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 120 additions and 128 deletions
Download patch file Download diff file Expand all files Collapse all files

4
packages/docusaurus-plugin-content-docs/src/sidebars/processor.ts
View file

@ -19,6 +19,7 @@ import type {
NormalizedSidebarItemCategory,
SidebarItemCategory,
SidebarItemAutogenerated,
CategoryMetadataFile,
} from './types';
import {transformSidebarItems} from './utils';
import {DefaultSidebarItemsGenerator} from './generator';
@ -39,6 +40,7 @@ export type SidebarProcessorParams = {
version: VersionMetadata;
categoryLabelSlugger: Slugger;
sidebarOptions: SidebarOptions;
categoriesMetadata: Record<string, CategoryMetadataFile>;
};
function toSidebarItemsGeneratorDoc(
@ -72,6 +74,7 @@ async function processSidebar(
docs,
version,
sidebarOptions,
categoriesMetadata,
} = params;
// Just a minor lazy transformation optimization
@ -101,6 +104,7 @@ async function processSidebar(
isCategoryIndex,
...getSidebarItemsGeneratorDocsAndVersion(),
options: sidebarOptions,
categoriesMetadata,
});
// TODO validate generated items: user can generate bad items