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

Add site search to the new MDX website #1776

Open
ChristianMurphy opened this issue Oct 24, 2021 · 3 comments
Open

Add site search to the new MDX website #1776

ChristianMurphy opened this issue Oct 24, 2021 · 3 comments
Labels
🕸 area/website This affects the website 👍 phase/yes Post is accepted and can be worked on 🦋 type/enhancement This is great to have

Comments

@ChristianMurphy
Copy link
Member

Subject of the feature

Have a way to search all documentation pages on the website.

Problem

Currently there is no way to search for specific content on the MDX site itself.
Adopters either have to click through pages looking for where a relevant section is, or to go off the website to a search engine and do a site scoped search from there.
For example if I'm looking for the Vue guide, I have go click through the site until I eventually find https://v2.mdxjs.com/packages/vue/#use several layers of navigation in.

Expected behavior

Have a way to search the documentation built into the site

Alternatives

  • Don't include search on the site
  • Add a link to a search engine with the site scope setup

Potential solutions

@ChristianMurphy ChristianMurphy added 🦋 type/enhancement This is great to have 🔍 status/open 🕸 area/website This affects the website labels Oct 24, 2021
@wooorm
Copy link
Member

wooorm commented Oct 25, 2021

@wooorm wooorm added 🙉 open/needs-info This needs some more info and removed 🔍 status/open labels Dec 24, 2021
@mizozobu
Copy link

This is probably the easiest way to integrate algolia to an OSS documentation site and probably this project can be listed on docsearch's homepage.

https://docsearch.algolia.com

@wooorm wooorm added 👍 phase/yes Post is accepted and can be worked on and removed 🙉 open/needs-info This needs some more info labels Feb 1, 2022
@shortcuts
Copy link

Hey there! I can confirm DocSearch was running for the v1 website, and we still have the setup up and running!

I've made a (really basic) update on our side just to make it work for the current website, csb - live demo

You can use the credentials you see on the sandbox, they are yours and public so no worry about disclosing it. For the account owner, I see @johno so let me know if I should send a new invite or add someone else :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🕸 area/website This affects the website 👍 phase/yes Post is accepted and can be worked on 🦋 type/enhancement This is great to have
Development

No branches or pull requests

4 participants