Add Document Search #534
Merged
Add Document Search #534
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rafaparadela
approved these changes
Jan 26, 2021
There was a problem hiding this comment.
This is a pretty cool feature @sloshy and the result is outstanding. Thanks.
calvellido
approved these changes
Jan 26, 2021
There was a problem hiding this comment.
It looks great @sloshy, really cool addition to the plugin! 🙌
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #503 and #196.
Depends on #529 (please review that first)
Adds a basic search functionality, client-side and enabled by default, to sbt-microsites. Currently the search only provides links to documents, and not headings within each document. Doing that would require a bit more effort, and I believe this is a good stop-gap solution for search that at least gets our foot in the door.
How it works:
There is a search bar at the top of the home page and all document pages. Typing terms in the search (according to https://lunrjs.com/ rules) will generate a score, and use this to search relevant results. The user can press the up and down arrow keys to navigate the list, or ESC to close the drop-down.
Basic demo of search, nav, and ESC to close:
Screen.Recording.2021-01-25.at.6.47.58.PM.mov
The search index is generated client-side using the contents of each document in a special JS file. If search is disabled, this will never be generated and the resulting files are smaller.