-
-
Notifications
You must be signed in to change notification settings - Fork 5.7k
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
Dedicated Sticky TOC (Table of Contents) on Right Side #1560
Comments
Merge this plugin into docsify, its way is also plugin, why not just use it? |
I feel this is an essential feature considering the UX trend across many doc pages. It took me a long time to implement it into my project. The essential level is similar to search, disqus and emoji. I strongly believe this feature also attracts new users. I hope to see this feature as a part of default plugins. |
cc @docsifyjs/reviewers |
Thx for ur good suggestion. 👍 |
Fully agree on this. The ability to toggle a theme-responsive sticky auto-generated TOC on the right side would be a much appreciated addition to Docsify. Unfortunately I don't have the tech skills to offer to work on implementing this feature. |
This already works as a plugin, I don't think there is a need to make it part of Docsify. We should make sure we don't break Docsify APIs so that plugins like docsify-plugin-toc will continue to work. However we can definitely add it to the Any ideas on how we can improve the left-side sidebar to make that easier, instead of duplicating content? |
Feature request
I would like to see a sticky TOC on dedicated right side section rather than putting inside the left sidebar as it is difficult to navigate with a lot of contents.
What problem does this feature solve?
Sticky TOC is becoming popular on Doc (i.e https://docs.docker.com/get-started/). Other doc framework such as Docusaurus also has this feature by default. It is more natural to see TOC on right side rather than side bar combined with navigation links.
What does the proposed API look like?
We can possibly incorporate docsify-plugin-toc plugin
https://github.com/justintien/docsify-plugin-toc
How should this be implemented in your opinion?
I believe we can fully borrow the idea from the plugin above
Demo: https://blog.jiapan.tw/ops/cloud/README
Are you willing to work on this yourself?
No
The text was updated successfully, but these errors were encountered: