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

Integrate experimental in-browser search #1165

Merged
merged 28 commits into from
May 31, 2023

Conversation

sabine
Copy link
Collaborator

@sabine sabine commented May 9, 2023

Here's a WIP patch that integrates the experimental search index voodoo currently emits (ocaml-doc/voodoo#58 and ocaml-doc/voodoo#59).

Using the MiniSearch library, we provide an extremely basic search for identifiers within a package.

  • search index is only loaded when interacting with the search input
  • keyboard up/down/enter interaction
  • 'S' keypress shortcut to focus the search input
  • color-coded and tagged results list
  • search index is served under immutable digest-URL to allow indefinite caching

sabine added a commit that referenced this pull request May 9, 2023
sabine added a commit that referenced this pull request May 9, 2023
sabine added a commit that referenced this pull request May 9, 2023
sabine added a commit that referenced this pull request May 9, 2023
sabine added a commit that referenced this pull request May 9, 2023
sabine added a commit that referenced this pull request May 10, 2023
sabine added a commit that referenced this pull request May 12, 2023
sabine added a commit that referenced this pull request May 15, 2023
add a shadow and boost shorter results a96b989
sabine added a commit that referenced this pull request May 15, 2023
add a shadow and boost shorter results a96b989
sabine added a commit that referenced this pull request May 19, 2023
@sabine fix scrolling to element on current page 6476d5d
sabine added a commit that referenced this pull request May 19, 2023
@sabine show the full docstring on active element 877fc17
sabine added a commit that referenced this pull request May 19, 2023
@sabine only collapse docstring on md+ screens bfbf2e6
sabine added a commit that referenced this pull request May 19, 2023
@sabine no longer need to reverse prefix name 3777399
sabine added a commit that referenced this pull request May 19, 2023
@sabine fixes scrolling on mobile, adds more quality of life features
1940dfa
sabine added a commit that referenced this pull request May 19, 2023
@sabine
prevent hijacking of 'S' key in top search bar
b8d6dce
sabine added a commit that referenced this pull request May 19, 2023
@sabine
Integrate experimental in-browser search #1165
fa8f8e4
sabine added a commit that referenced this pull request May 22, 2023
commit b45d61b
Author: Sabine Schmaltz <sabineschmaltz@gmail.com>
Date:   Mon May 22 15:04:03 2023 +0200

    add a loading indicator for the search index on first interaction with the input
@sabine sabine marked this pull request as ready for review May 22, 2023 13:06
sabine added a commit that referenced this pull request May 22, 2023
commit 95618b6
Author: Sabine Schmaltz <sabineschmaltz@gmail.com>
Date:   Mon May 22 15:27:26 2023 +0200

    limit max-height of docstring - see Lwt.bind
cuihtlauac pushed a commit that referenced this pull request May 22, 2023
commit 95618b6
Author: Sabine Schmaltz <sabineschmaltz@gmail.com>
Date:   Mon May 22 15:27:26 2023 +0200

    limit max-height of docstring - see Lwt.bind
sabine added a commit that referenced this pull request May 23, 2023
commit a74aa79
Author: Sabine Schmaltz <sabineschmaltz@gmail.com>
Date:   Tue May 23 10:50:11 2023 +0200

    add aria attributes for better accessibility
sabine added a commit that referenced this pull request May 23, 2023
commit a74aa79
Author: Sabine Schmaltz <sabineschmaltz@gmail.com>
Date:   Tue May 23 10:50:11 2023 +0200

    add aria attributes for better accessibility
@sabine sabine merged commit 5bb54d6 into ocaml:main May 31, 2023
@sabine sabine deleted the integrate_odoc_search branch May 31, 2023 07:40
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

Successfully merging this pull request may close these issues.

1 participant