Skip to content
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

Enable search for docs #660

Closed
wants to merge 1 commit into from
Closed

Enable search for docs #660

wants to merge 1 commit into from

Conversation

eriktisme
Copy link
Contributor

Changes
Enabled search for the documentation. It would be nice if there was full text search but you would need to sign up for Algolia (I guess you want to do it yourself as a package owner). Documentation for Algolia search can be found here

@spawnia
Copy link
Collaborator

spawnia commented Mar 11, 2019

image

I don't like how the search results are doubled for each version. This is only going to get worse over time.

Can you look into that?

@alberthaff
Copy link
Collaborator

alberthaff commented Mar 11, 2019

The problem is, that is does not limit the search results to a specific version, so everything shows up twice (since there is currently two versions of the docs).

EDIT: Damnit, you beat be to it @spawnia :-)

@eriktisme
Copy link
Contributor Author

@spawnia Ah yes I will look into that

@alberthaff
Copy link
Collaborator

alberthaff commented Mar 11, 2019

I fear that we have to use the eject-feature in Vuepress in order to change the core behaviour of the search-box. However, we might be able to overwrite AlgoliaSearchBox through enhanceApp.js.

@eriktisme
Copy link
Contributor Author

eriktisme commented Mar 11, 2019

I found a feature request in the vuepress repository vuejs/vuepress#857

Edit: I will have a closer look tomorrow after work.

@robsontenorio
Copy link
Contributor

robsontenorio commented Mar 12, 2019

You should to use searchable paths. Did it in the past looking forward mutiple folder duplication.

vuejs/vuepress#1032

@spawnia
Copy link
Collaborator

spawnia commented Mar 12, 2019

@robsontenorio nice!

Seems to be out in alpha only, but i am willing to take that risk 🔥

Can you provide a PR where you update vuepress and add this in, as you seem to be quite well-versed in it?

@robsontenorio
Copy link
Contributor

robsontenorio commented Mar 12, 2019 via email

@eriktisme
Copy link
Contributor Author

@robsontenorio I'll close this pull request and looking forward to yours! 👍

@eriktisme eriktisme closed this Mar 12, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants