Page TOC and search in the content

reanim8ed commented 5 years ago

Feature request

I would like to migrate my wiki from Gitbook and VuePress is one of my main options, especially because of the speed. But I'm missing a couple of important features and without them usefulness of the wiki is redused greatly:

Table Of Content in the page could be implemented as the right sidebar: http://bit.ly/2KnU15a
Search could include results from the content too: http://bit.ly/2Kv5qjW

What problem does this feature solve?

TOC - currently Table Of Contents is implemented as markdown extension but it places TOC in the content itself. Then the page is really long it's not convienent to scroll all the way to the top to access it. It would be better UX to implement it like additional sticky sidebar which would be easily accessible no matter where in the page the user is.

Search - most of the times then I'm searching, the keyword is not in the heading but in the content. Current search works great but because it doesnt include results from the content it's much less useful.

What does the proposed API look like?

N/A

How should this be implemented in your opinion?

There should be a global option for single page TOC which could toggle the showing of the page TOC sidebar. [[toc]] shortcode shouldn't be neccesary anymore.

Are you willing to work on this yourself?

I'm not a Vue developer

nkhdo commented 5 years ago

Anyone on this? Or can I take it?

lunaceee commented 5 years ago

Hi @nkhdo , I had success adding a global table-of-contents on my VuePress site and I'd be happy to implement the feature. I'll come up with some descriptions to the proposed API section shortly.

kefranabg commented 4 years ago

For a full text search, you can use https://vuepress.vuejs.org/theme/default-theme-config.html#algolia-docsearch

kefranabg commented 4 years ago

Feel free to open a PR for the side bar toc feature

ghana04 commented 4 years ago

Any updates on this?

josx commented 4 years ago

@kefranabg i think we dont have to relay on 3er party provider/website to do search. Would be much better to have a plugin to do it.

eblanshey commented 4 years ago

This would be a wonderful addition, to move table of contents to a sticky sidebar on the right, and remove the table of contents from the left page navigation. Some other documentation generators have this out of the box, such as Docusaurus, and would be nice to have it available here as well.

rexwangcc commented 4 years ago

Any updates on this, especially the right-side sticky ToC bar? I came across a custom theme which seems to be already supporting this feature. It would be really appreciated if it's provided out-of-box by default.

vuejs / vuepress