Add support for searching #446
Merged
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
pagefind generates a search index from the site and inserts a search box into the page that searches it. Subdoc does not run pagefind automatically, because the results are a bit subpar. Searching "option" doesn't list the Option class in the first page of results even though the page has a 20 weight on the name "Option". The namespace comes up first, and it has a 10 weight on the same. Also the search box is quite big and both the box and results are hard to configure visually as they don't provide helpful css classes to work with. So we should try another tool out.
Now that we get the resource dir from clang, we shouldn't need system include paths in the compile commands.
lunr builds an index from a set of fields, which we generate with subdoc into 'search.json' The webpage loads the json file and puts it into a lunr index. In the future this could be done offline and serialized, but it would need JS execution during Subdoc execution or during page deployment.
Searches are done without doing a full navigation/page load. Any typing causes a new search to be done (with a delay for throttling). Hitting Escape unfocuses the search box and hides search results. Re- focusing the search box shows the results again.
danakj
changed the title
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.
We use lunrjs to perform the searching on a (json) search index that we create during html generation.