docsify icon indicating copy to clipboard operation
docsify copied to clipboard

Proposal: Allow :include in sidebar

Open nsainaney opened this issue 5 years ago • 3 comments

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

nsainaney avatar Jul 31 '20 21:07 nsainaney

Maybe auto generate would be better? #1290

sy-records avatar Aug 01 '20 09:08 sy-records

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 avatar Jan 26 '22 17:01 trusktr

@nsainaney keeping open to track it. Please unsubscribe if you'd like to not receive updates.

trusktr avatar Feb 02 '22 17:02 trusktr