docsify icon indicating copy to clipboard operation
docsify copied to clipboard

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

Open trusktr opened this issue 6 years ago • 5 comments

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.

trusktr avatar Dec 19 '19 05:12 trusktr

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.

anikethsaha avatar Dec 19 '19 08:12 anikethsaha

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 avatar Dec 29 '19 21:12 trusktr

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.

trusktr avatar Dec 29 '19 22:12 trusktr

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 avatar Dec 30 '19 19:12 anikethsaha

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

I am +1 for both tabs and collapsible.

🎉

anikethsaha avatar Dec 30 '19 19:12 anikethsaha