fix: genIndex error for search by wangliang181230 · Pull Request #1933 · docsifyjs/docsify

wangliang181230 · 2022-12-06T02:23:36Z

1. url is wrong if multiple contents are on the same site, example: https://xxxxx/docs/ and https://xxxxx/blog/
2. when the token.text is undefined, handlePostContent is undefined too at line 217
https://github.com/docsifyjs/docsify/blob/develop/src/plugins/search/search.js#L217

Summary

What kind of change does this PR introduce?

For any code change,

Related documentation has been updated if needed
Related tests have been updated or tests have been added

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

Yes
No

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

Related issue, if any:

Tested in the following browsers:

1. url is wrong if multiple contents are on the same site, example: `https://xxxxx/docs/` and `https://xxxxx/blog/` 2. when the `token.text` is undefined, `handlePostContent` is undefined too at line 216

…ires, this plugin can still operate normally

vercel · 2022-12-06T02:23:40Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
docsify-preview	✅ Ready (Inspect)	Visit Preview	Jan 3, 2023 at 6:54AM (UTC)

codesandbox-ci · 2022-12-06T02:24:50Z

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 f41ee5a:

Sandbox	Source
docsify-template	Configuration

wangliang181230 · 2022-12-06T02:39:04Z


- index[slug].body = index[slug].body
- ? index[slug].body + token.text
- : token.text;


index[slug].body is always undefined, see the line 122
120if(!index[slug]){121index[slug]={ slug,title: '',body: ''};122}elseif(index[slug].body){ ...... 127}else{ ...... //index[slug].body is always undefined}

When the token.text is undefined, it will make the index[slug].body also undefined.
So I change the token.text to token.text || ''.

The code index[slug].body ? index[slug].body + token.text : is redundant, and it is not the cause of the bug.

nice point.

wangliang181230 · 2022-12-06T02:43:38Z

+ INDEXS = isExpired ? null : JSON.parse(localStorage.getItem(indexKey));

- if (isExpired) {
+ if (!INDEXS) {


When manually delete docsify.search.index and keep docsify.search.expires, this plugin can still operate normally

The user should know what he does when he gonna manually delete index.

Just to reduce a manual operation step during the test, haha.

Just to reduce a manual operation step during the test, haha.
If user wanna break it, he should break it.

Then this change is not necessary, is it?
If not, I'll revert this code.

Then this change is not necessary, is it? If not, I'll revert this code.
yep. personally, I think we do not need handle this case.

Koooooo-7 · 2022-12-14T10:15:43Z

+ slug = '#/' + slug.substring(5);
+ }
+ slug = pathname + (flag ? '/' : '') + slug;
+


What does those changes for ? could you plz give a sample and add verify test cases.

When my website has multiple paths, it can prevent 404 error.
For example:
http://xxxxxx/A/
http://xxxxxx/B/
When searching on page A and accessing page B, 404 will appear.

When my website has multiple paths, it can prevent 404 error. For example: http://xxxxxx/A/http://xxxxxx/B/ When searching on page A and accessing page B, 404 will appear.
I see, maybe u can take a look on this namespace configs here.

I see, maybe u can take a look on this namespace configs here.
Should I configure it like this?
{ search: [ '/A', '/B' ] }
or
{ search: { paths: [ '/A', '/B' ] } }

I guess you need distinguish those namespace for different paths (sites), may could refer to our site with multi langs nav . if you deploy multi sites in same domain, the namespace config should be in each site's index.html search config.
// Use different indexes for path prefixes (namespaces).// NOTE: Only works in 'auto' mode.//// When initialiazing an index, we look for the first path from the sidebar.// If it matches the prefix from the list, we switch to the corresponding index.pathNamespaces: ['/zh-cn','/ru-ru','/ru-ru/v1'],

Ok, I will try it.

wangliang181230 · 2023-01-03T06:55:10Z

PTAL

Koooooo-7

LGTM.

wangliang181230 added 5 commits July 23, 2022 23:13

fix search.js
306d606
1. url is wrong if multiple contents are on the same site, example: `https://xxxxx/docs/` and `https://xxxxx/blog/` 2. when the `token.text` is undefined, `handlePostContent` is undefined too at line 216

fix 404
30fa174

Merge remote-tracking branch 'origin/develop' into patch-1
86d3c5f

When manually delete docsify.search.index and keep docsify.search.exp…
7b974ef
…ires, this plugin can still operate normally

optimize fix 404
fa12461

vercelBotdeployed to Preview December 6, 2022 02:24 View deployment

wangliang181230 commented Dec 6, 2022
View reviewed changes

Merge branch 'develop' into bugfix-1
558a8d1

vercelBotdeployed to Preview December 13, 2022 14:25 View deployment

Koooooo-7 reviewed Dec 14, 2022
View reviewed changes

Merge branch 'develop' into bugfix-1
70e921b

vercelBotdeployed to Preview December 16, 2022 13:37 View deployment

wangliang181230 added 2 commits January 3, 2023 14:50

Merge remote-tracking branch 'upstream/develop' into bugfix-1
95bfa6d

revert
b1df79d

vercelBotdeployed to Preview January 3, 2023 06:52 View deployment

revert fix 404
f41ee5a

vercelBotdeployed to Preview January 3, 2023 06:54 View deployment

wangliang181230 changed the title ~~fix: fix search.js two BUGs: 404 and handlePostContent is undefined~~fix: fix handlePostContent is undefinedJan 3, 2023

Koooooo-7 approved these changes Jan 3, 2023
View reviewed changes

Koooooo-7 requested a review from a teamJanuary 3, 2023 07:13

sy-records approved these changes Jan 3, 2023
View reviewed changes

sy-records changed the title ~~fix: fix handlePostContent is undefined~~fix: genIndex error for searchJan 3, 2023

sy-records merged commit a8f9fc1 into docsifyjs:developJan 3, 2023

wangliang181230 deleted the bugfix-1 branch January 3, 2023 07:47

sy-records pushed a commit that referenced this pull request Jun 24, 2023
fix: genIndex error for search (#1933)
68d8735

sy-records mentioned this pull request Jun 24, 2023
[Release] 4.13.1 #2101
Merged

sy-records mentioned this pull request May 5, 2025
[Release]: v5.0.0-rc.1 #2543
Merged

sy-records mentioned this pull request Jul 17, 2026
[Release]: v5.0.0 #2745
Merged

Uh oh!

Uh oh!

Conversation

wangliang181230 commented Dec 6, 2022• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

What kind of change does this PR introduce?

For any code change,

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

Related issue, if any:

Tested in the following browsers:

Uh oh!

vercelBot commented Dec 6, 2022• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codesandbox-ciBot commented Dec 6, 2022• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wangliang181230Dec 6, 2022• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wangliang181230Dec 14, 2022• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wangliang181230Dec 14, 2022• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wangliang181230Dec 19, 2022• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wangliang181230Dec 19, 2022• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Koooooo-7Jan 3, 2023• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wangliang181230 commented Jan 3, 2023

Uh oh!

Koooooo-7 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

wangliang181230 commented Dec 6, 2022•
edited
Loading

vercelBot commented Dec 6, 2022•
edited
Loading

codesandbox-ciBot commented Dec 6, 2022•
edited
Loading

wangliang181230Dec 6, 2022•
edited
Loading

wangliang181230Dec 14, 2022•
edited
Loading

wangliang181230Dec 14, 2022•
edited
Loading

wangliang181230Dec 19, 2022•
edited
Loading

wangliang181230Dec 19, 2022•
edited
Loading

Koooooo-7Jan 3, 2023•
edited
Loading