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

feature: support of all markdown features and plugins in the sidebar. #984

Open
trusktr opened this issue Dec 19, 2019 · 5 comments
Open

Comments

@trusktr
Copy link
Member

trusktr commented Dec 19, 2019

Feature request

It'd be great for all markdown features of pages to also work in the sidebar too. For example, suppose we want to use https://github.com/jhildenbiddle/docsify-tabs to put tabs in the sidebar, or something.

What problem does this feature solve?

Makes the site more customizable.

What does the proposed API look like?

From an end user perspective, they just write markdown, and it would work like it does in a page.

How should this be implemented in your opinion?

Not sure yet.

Are you willing to work on this yourself?

Yes, when I can find the time.

@anikethsaha
Copy link
Member

Tabs in the sidebar are not much useful. Maybe collapsable in the sidebar.

I think these can be done using script in the markdown file itself.

Can you name a few features which can be implemented?

If plugins for the sidebar is aimed, then we need more hooks in the lifecycle. But before working on this we need the correct use-case which will be solved.
Also I would keep this for v5 as tests are my first priority.

@trusktr
Copy link
Member Author

trusktr commented Dec 29, 2019

Here's a good example of tabs in the sidebar, in the Three.js docs: https://threejs.org/docs/index.html#manual/en/introduction/Creating-a-scene

It works really well there.

@trusktr
Copy link
Member Author

trusktr commented Dec 29, 2019

I currently have "docs" and "examples" in my sidebar, as two lists stacked on top of each other, but it takes up much space. I like the separation of docs and examples in the Three.js sidebar.

In general, I think we can somehow improve the flexibility of the sidebar later.

@anikethsaha
Copy link
Member

Here's a good example of tabs in the sidebar, in the Three.js docs: https://threejs.org/docs/index.html#manual/en/introduction/Creating-a-scene

It works really well there.

They moved their navbar to sidebar right ?

@anikethsaha
Copy link
Member

In general, I think we can somehow improve the flexibility of the sidebar later.

I am +1 for both tabs and collapsible.

🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants