Repository navigation
Proposal: Allow :include in sidebar #1323
Description
Feature request
We are using TypeDoc to generate documentation for our library. We have created a custom TypeDoc theme that can generate sidebar elements (e.g. list of all the Classes, Interfaces etc. in our library)
We have tried butting the following:
- [My Library](lib/index.md)
- [toc](lib/toc.md ':include')
But it does not work in the sidebar. Include works in page content
What problem does this feature solve?
Will enable generated content to be rendered in the sidebar
How should this be implemented in your opinion?
Re-use the same code that handles ':include' in page content in the sidebar content
Are you willing to work on this yourself?
Need direction on where the sidebar and page content renderer code is
Activity
sy-records commentedon Aug 1, 2020
Maybe auto generate would be better? #1290
trusktr commentedon Jan 26, 2022
We have too much difference between sidebar/nav markdown processing, and main processing. I think some features make sense to have in both places (it would be intuitive). We will be cleaning up some code to consolidate markdown processing code paths into one cohesive path. I think at this point we may allow some shared features.
trusktr commentedon Feb 2, 2022
@nsainaney keeping open to track it. Please unsubscribe if you'd like to not receive updates.
":include"helper, or similar, for _sidebar and _navbar. #1978