Add search bar #94
Merged
Add search bar #94
Conversation
This file contains hidden or 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
kimmcintyre
force-pushed
the
search-bar
branch
from
6ea9136 to
89d7029
Compare
|
Hi Kim, thanks for the PR. I've asked @SimonDarksideJ to take a look. |
|
Thanks @kimmcintyre this is going to help so many people 🎉 |
|
A simple change, yet so powerful. It's a wonder why that feature is not advertised much. |
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.
Addresses issue #91
Turns on DocFX's search bar for the doc site. Here is an example of searching for
DepthStencilStatein my local doc site.DocFX's search bar is powered by lunr.js and therefore is subject to the idiosyncrasies of this search engine as described in the lunr docs.
For example, lunr assumes each term in the search query is atomic. So searching for
graphandgraphicwill yield different results.Additionally, lunr assumes a logical OR when searching with multiple terms. Therefore, searching
aspect ratiowill return the combined results of the two separate search queries foraspectandratiobut not for the specific phraseaspect ratio. This can be partially mitigated by using the search query+aspect +ratiobut this will only serve to return documents that have both of these words but not necessarily together in the phraseaspect ratioSo the search functionality that DocFX provides is not perfect, but I do believe that the additional functionality it has over the ToC filter makes it worth enabling.