3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-06-19 19:22:28 +02:00
Code Issues Projects Releases Packages Wiki Activity
docusaurus/packages/docusaurus-plugin-content-docs/src/sidebars
History
Joshua Chen 2d93750caf
fix(content-docs): improve sidebar shorthand normalization error message (#6745)
2022-02-23 13:03:58 +01:00
..
__tests__ fix(content-docs): improve sidebar shorthand normalization error message (#6745) 2022-02-23 13:03:58 +01:00
generator.ts refactor: ensure lodash is default-imported (#6716) 2022-02-19 18:15:02 +08:00
index.ts refactor: convert all fs methods to async (#6725) 2022-02-20 10:21:33 +08:00
normalization.ts fix(content-docs): improve sidebar shorthand normalization error message (#6745) 2022-02-23 13:03:58 +01:00
postProcessor.ts refactor: ensure lodash is default-imported (#6716) 2022-02-19 18:15:02 +08:00
processor.ts refactor: ensure lodash is default-imported (#6716) 2022-02-19 18:15:02 +08:00
README.md refactor(content-docs): clean up sidebars logic; validate generator returns (#6596) 2022-02-04 09:46:25 +08:00
types.ts feat(docs,theme-classic): docs breadcrumbs (#6517) 2022-02-16 19:02:58 +01:00
utils.ts fix(content-docs): improve sidebar shorthand normalization error message (#6745) 2022-02-23 13:03:58 +01:00
validation.ts refactor(content-docs): clean up sidebars logic; validate generator returns (#6596) 2022-02-04 09:46:25 +08:00

README.md

Sidebars

This part is very complicated and hard to navigate. Sidebars are loaded through the following steps:

  1. Loading. The sidebars file is read. Returns SidebarsConfig.
  2. Normalization. The shorthands are expanded. This step is very lenient about the sidebars' shapes. Returns NormalizedSidebars.
  3. Validation. The normalized sidebars are validated. This step happens after normalization, because the normalized sidebars are easier to validate, and allows us to repeatedly validate & generate in the future.
  4. Generation. This step is done through the "processor" (naming is hard). The autogenerated items are unwrapped. In the future, steps 3 and 4 may be repeatedly done until all autogenerated items are unwrapped. Returns ProcessedSidebars.
  5. Post-processing. Defaults are applied (collapsed states), category links are resolved, empty categories are flattened. Returns Sidebars.