Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proposal: Allow :include in sidebar #1323

Open
nsainaney opened this issue Jul 31, 2020 · 3 comments · Fixed by docsifyjs/docsify-cli#130
Open

Proposal: Allow :include in sidebar #1323

nsainaney opened this issue Jul 31, 2020 · 3 comments · Fixed by docsifyjs/docsify-cli#130

Comments

@nsainaney
Copy link

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

@sy-records
Copy link
Member

Maybe auto generate would be better? #1290

@trusktr
Copy link
Member

trusktr commented 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
Copy link
Member

trusktr commented Feb 2, 2022

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

@trusktr trusktr reopened this Feb 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants