Integrating Custom Elasticlunr Search with Popup Display

[sachin-suresh-rapyuta]

I'm attempting to integrate Elasticlunr search into the Sphinx Awesome theme and display the search results in a popup, similar to how Algolia DocSearch functions. While I have successfully integrated the search functionality, I am facing difficulties in getting the search results to appear in a popup on the same page, without redirecting to a separate search.html page.

Note: I cannot use Algolia as our doc site is private.

Steps Taken:

1. Implemented Elasticlunr search with custom search.js and search.html files.
2. Attempted to follow the theme's guidelines for customizing templates, but the popup doesn't appear when clicking on the search input.
3. Instead, the search redirects to the search.html page where another search input appears, which isn't the desired behavior.

Actual Behavior:

• The search functionality works, but the results are shown on a separate search.html page, which requires the user to re-enter the search term.

• The expected popup does not appear, and the integration does not fully align with the theme's default behavior for search.

Request:

It would be beneficial to have documentation or guidance on how to correctly integrate a custom search, like Elasticlunr, into the Sphinx Awesome theme, particularly for achieving a seamless popup-based search experience. Any insights or recommendations would be greatly appreciated.

[kai687]

I have no experience with Elasticlunr, but here's what I do know:

You need to get rid of the form action='search.html' that submits the form to open the Search results page with the entered search query. You could do this by customizing the searchbox.html template. For more information, see Add custom templates.

[sachin-suresh-rapyuta]

Thanks @kai687. I was able to successfully integrate Elasticlunr with some customizations.