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

Enhanced side bar search widget #44

Open
starbelly opened this issue Nov 7, 2021 · 1 comment
Open

Enhanced side bar search widget #44

starbelly opened this issue Nov 7, 2021 · 1 comment

Comments

@starbelly
Copy link
Contributor

starbelly commented Nov 7, 2021

Currently, the search widget on the sidebar is the stock widget provided out of the box via docsearch.js. Doing some quick research it seems the idea behind the search widget provided by docsearch.js is primarily to get a site up and going with minimal to zero js/ts hacking required.

That's a great way to bootstrap but it has some limitations. It doesn't appear easy or possible to extend the widget anymore with docsearch v3, though perhaps more research is required.

It may be that we need to "fork" the widget to add the functionality we'd like to see on erlang.org. Below are a few enhancements we'd like to see :

Preview

On agolia's site we can see a nice side preview of a document as can be seen below :

140641385-8eaf6aa9-5c3e-4824-bc2f-8db035af5a5b

## More results

While it's great to get all the results possible in the widget, it may be a better UX to limit the results and provide a link to the new search page added in #41 . This is also a nice to have as after clicking such a link, someone could bookmark the search. An example of this can be seen on docsearch's own page (show below) :

@starbelly
Copy link
Contributor Author

starbelly commented Nov 8, 2021

Update @garazdawi figured out how to do the more search results link (#47), with that more digging is required before forking, as I have feeling the customization can be done with docsearch.js's widget.

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

No branches or pull requests

1 participant