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

Improved the Native Search Algorithm #1

Merged
merged 3 commits into from Apr 24, 2019
Merged

Conversation

ynnelson
Copy link
Owner

You can now search tags in addition to H2 and H3 titles as well as the search can now take in multiple words separated by a space.

Summary

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Docs
  • Build-related changes
  • Other, please describe:

I simply improved the suggestions () method in the SearchBox component to now include tags if they exist in the frontmatter, this is combined with the existing behavior of searching through headers. Also, the other improvement is that you can now do a search based on multiple keywords as opposed to only one previously.

This is a very minor adjustment which I think will satisfy a lot of the issues with the native search and allows the user to make pages show up in the search based on the tags assigned to it.

If changing the UI of default theme, please provide the before/after screenshot:

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

If yes, please describe the impact and migration path for existing applications:

The PR fulfills these requirements:

  • When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)

You have tested in the following browsers: (Providing a detailed version will be better.)

  • Chrome
  • Firefox
  • Safari
  • Edge
  • IE

If adding a new feature, the PR's description includes:

  • A convincing reason for adding this feature
  • Related documents have been updated
  • Related tests have been updated

To avoid wasting your time, it's best to open a feature request issue first and wait for approval before working on it.

Other information:

You can now search tags in addition to H2 and H3 titles as well as the search can now take in multiple words separated by a space.
@ynnelson ynnelson marked this pull request as ready for review April 24, 2019 19:09
@ynnelson ynnelson merged commit 242a01e into master Apr 24, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant