-
Notifications
You must be signed in to change notification settings - Fork 4.8k
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
Page TOC on right side of page instead of inlined with sidebar #2398
Comments
@Mister-Hope Yes. |
I'm upvoting this as well. I think it would be great to simply include this as a configurable item in the config.js to give the user the flexibility to choose rather than having to custom code a solution. While I understand that this is a somewhat involved project to begin with, having these types of features would absolutely put this above and beyond the competition, especially for those who aren't quite as savvy when it comes to coding (such as myself). |
Recently I just solve it. I am using vuepress@1.9.10. |
Feature request
What problem does this feature solve?
These days there are lots of documentation portals are using layout where page toc links are shown on the right and page tree is shown on the left. As of now, vuepress shows page tree as well page toc inlined. Being able to display page toc on right would reduce the left nav tree and can significantly improve the readability of docs.
What does the proposed API look like?
This would be a configuration for default theme.
May be add, pageTocLocation: 'inline' or 'right'
How should this be implemented in your opinion?
The logic where it generates sidebar needs to be updated to factor in pageTocLocation field to skip generating page toc. And then page renderer needs to generate pages with toc on the right.
Are you willing to work on this yourself?
I don't have experience on this but will try.
The text was updated successfully, but these errors were encountered: