3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-07-27 13:38:33 +02:00
Code Issues Projects Releases Packages Wiki Activity
docusaurus/packages/docusaurus-plugin-content-docs/src/sidebars
History
Joshua Chen fa1ce230ea
refactor: capitalize comments (#7188) 
* refactor: capitalize comments

* revert...
2022-04-17 16:39:11 +08:00
..
__tests__ feat(content-docs): draft docs excluded from build & sidebars (#6457) 2022-04-13 18:02:05 +02:00
generator.ts refactor: capitalize comments (#7188) 2022-04-17 16:39:11 +08:00
index.ts refactor(content-docs): split version handling into several files (#7140) 2022-04-09 17:08:57 +08:00
normalization.ts feat(logger): new "url" format, add double quotes around paths (#7019) 2022-03-27 14:59:20 +08:00
postProcessor.ts refactor: capitalize comments (#7188) 2022-04-17 16:39:11 +08:00
processor.ts feat(content-docs): draft docs excluded from build & sidebars (#6457) 2022-04-13 18:02:05 +02:00
README.md refactor(content-docs): clean up sidebars logic; validate generator returns (#6596) 2022-02-04 09:46:25 +08:00
types.ts refactor: capitalize comments (#7188) 2022-04-17 16:39:11 +08:00
utils.ts refactor(content-docs): deduplicate types, JSDoc for some APIs (#7027) 2022-03-27 12:57:15 +08:00
validation.ts refactor: ensure all types are using index signature instead of Record (#6995) 2022-03-25 18:06:30 +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.