vuepress icon indicating copy to clipboard operation
vuepress copied to clipboard

Page TOC on right side of page instead of inlined with sidebar

Open brsanthu opened this issue 5 years ago • 4 comments

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.

brsanthu avatar May 22 '20 17:05 brsanthu