feat: optionally allow the primary sections of the project sidebar be collapsible #258
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
From the Table channel: https://discord.com/channels/719702312431386674/1266888851260182548
This change makes the sections in the sidebar of the documentation portion of the website collapsible, by project-specific configuration in their
docs/config.json
file.Configuration
If you want to make a section collapsible, you'll need to add
collapsible: true
to the overarching section in the individual Project'sdocs/config.json
. Furthermore, you can optionally choose to have the sidebar section be in its 'collapsed' by default, using thedefaultCollapsed
property by setting it totrue
.Note
If the
collapsible
property resolves tofalse | undefined
, then any value set on thedefaultCollapsed
property will be disregarded and have no effect on the rendered content.E.g.
Screenshots
Before:
After: