Integrate with "Search As You Type" #19
Assignees
Comments
|
I'd like to add a similar bar than the one we have at the bottom, with some help (keys) and the Read the Docs logo. Also, a magnifier icon and a X in the input.
|
|
Another good example to follow when there are no results
|
|
Recent queries 💯
|
humitos
added a commit
that referenced
this issue
Mar 25, 2023
- update styles - integrate under `/` Related #19
humitos
added a commit
that referenced
this issue
Mar 25, 2023
- update styles - integrate under `/` I copied all the code from readthedocs/readthedocs-sphinx-search#132. However, there are lot of things that are not required for this stage. I removed some of them and make the integration nicer with the client we are creating. These changes are related to the HTML structure and the CSS style. The functionality is exactly the same. Related #19
humitos
added a commit
that referenced
this issue
Mar 25, 2023
- update styles - integrate under `/` I copied all the code from readthedocs/readthedocs-sphinx-search#132. However, there are lot of things that are not required for this stage. I removed some of them and make the integration nicer with the client we are creating. These changes are related to the HTML structure and the CSS style. The functionality is exactly the same. Related #19
|
I did some work in this direction in a358e57 and it looks like:
There are more work to do here, but I wanted to push the progress I have for now. |
|
The Algolia examples comes from https://popper.js.org/docs/v2/ |
|
Some progress here:
|
|
Beautiful! |
|
This work is already done, I'm going to close this issue. There some extra tweaks we can work on, of course, but the initial work has been done. This is how it currently looks on Docusaurus, for example:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
We have a Sphinx extension at https://github.com/readthedocs/readthedocs-sphinx-search that we talked about re-using/migrating/importing from this client. There are some work around making it a js package at readthedocs/readthedocs-sphinx-search#133
In a talk with Anthony we decided to start shipping features without using the flyout yet, since the flyout is one of the most complicated features of this js integration. However, I think we can start working on the search integration to be triggered with
/hotkey. That way, it requires zero-configuration nor any kind of integration with the HTML DOM.ToDo
/The text was updated successfully, but these errors were encountered: