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

fix: duplicate search content when /README or / exists in the sidebar #1403

Merged
merged 11 commits into from Nov 28, 2020

Conversation

sy-records
Copy link
Member

Summary

fix: duplicate search content when /README or / exists in the sidebar.

image

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

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

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.

@vercel
Copy link

vercel bot commented Oct 20, 2020

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/docsify-core/docsify-preview/3x18lja8p
✅ Preview: https://docsify-preview-git-fix-search.docsify-core.vercel.app

@codesandbox-ci
Copy link

codesandbox-ci bot commented Oct 20, 2020

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit d6800c3:

Sandbox Source
docsify-template Configuration

Copy link
Member

@jhildenbiddle jhildenbiddle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tested this PR locally and still encounter the issue. To reproduce the error:

  1. Add the following line to _sidebar.md:
    - [README](README)
    
  2. Launch test server with the following CLI command:
 node ./test/config/server.js --start
  1. Search for "generator"

Results

Screen Shot 2020-11-20 at 2 34 47 PM

We should also add tests for this scenario (no duplicates).

src/plugins/search/search.js Show resolved Hide resolved
@sy-records
Copy link
Member Author

I tested this PR locally and still encounter the issue. To reproduce the error:

  1. Add the following line to _sidebar.md:
    - [README](README)
    
  2. Launch test server with the following CLI command:
 node ./test/config/server.js --start
  1. Search for "generator"

Results

Screen Shot 2020-11-20 at 2 34 47 PM

You need to run npm run build:js first, then delete the local storage cache.

image

@jhildenbiddle
Copy link
Member

@sy-records --

Fixed the test. Required updating the Playwright config to clear local storage before each test. I assumed that would have been done before, but apparently not. See the following branch: https://github.com/docsifyjs/docsify/tree/pullrequests/sy-records/fix-search

Copy link
Member

@jhildenbiddle jhildenbiddle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

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.

None yet

3 participants