Skip to content

Search page #352

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

Closed
NoelDeMartin opened this issue Jul 28, 2020 · 3 comments · Fixed by #363
Closed

Search page #352

NoelDeMartin opened this issue Jul 28, 2020 · 3 comments · Fixed by #363
Labels
enhancement New feature or request

Comments

@NoelDeMartin
Copy link
Contributor

NoelDeMartin commented Jul 28, 2020

In v2 there was a separate search page at /search in order to have a url to run searches. For example: https://vuejs.org/v2/search/?q=v%2Dmodel

I implemented that in this PR, so you can take a look there for the motivations and discussion.

Would it make sense to do the same here? Would it make more sense to implement this feature in VuePress instead?

@NataliaTepluhina
Copy link
Member

@NoelDeMartin it would be great to have the same page for new docs! Regarding 'where to implement' question: I believe it would be beneficial for VuePress as well but if you think it would be faster/easier to add it to docs website only - let's implement it here first.

You also reminded me that I need to apply for Algolia DocSearch token 😅

@bencodezen bencodezen added the enhancement New feature or request label Jul 31, 2020
@bencodezen
Copy link
Member

bencodezen commented Jul 31, 2020

@NoelDeMartin VuePress comes with a built-in search functionality, so I wonder if it makes sense to see if there's a way you can leverage it to build the search page (rather than starting from scratch). That said, if VuePress search functionality could use some improvement, then I think we could use your help on updating the VuePress library itself so a lot more people can benefit from your ideas!

@NoelDeMartin
Copy link
Contributor Author

NoelDeMartin commented Jul 31, 2020

Hi @bencodezen. I've been looking into the @vuepress/plugin-search plugin and I'll probably make a PR to add it there afterwards.

But the docs at the moment are built using VuePress 1.3, and the latest version is 1.5. So I think it's still a good idea to add it here first. I'm not sure if the maintainers would accept a PR upgrading the VuePress dependency, and I'd also have to wait until a version with the search page is released.

If I create a PR here first, it's more likely that it gets merged before the official release of v3 :).

@NataliaTepluhina NataliaTepluhina linked a pull request Aug 2, 2020 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants