Skip to content

feat: improve indexing and embedded search - #2734

Merged
sy-records merged 3 commits into
docsifyjs:developfrom
sy-records:fix/2674
Jun 3, 2026
Merged

feat: improve indexing and embedded search#2734
sy-records merged 3 commits into
docsifyjs:developfrom
sy-records:fix/2674

Conversation

@sy-records

@sy-recordssy-records commented May 25, 2026•
edited
Loading

Copy link
Copy Markdown
Member

Summary

  • Fix Search indexing does not work if some links are broken
  • Allow full text search on embedded content

Related issue, if any:

Close#2674
Close#2689, Thanks @Bowl42
Close#2675, Thanks @kokovtsev
Close#1277

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Documentation content changes
  • Other (please describe):

For any code change,

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

Does this PR introduce a breaking change?

  • Yes
  • No

Tested in the following browsers:

  • Chrome
  • Firefox
  • Safari
  • Edge

@vercel

vercelBot commented May 25, 2026

Copy link
Copy Markdown

@sy-records is attempting to deploy a commit to the Docsify Team on Vercel.

A member of the Team first needs to authorize it.

@vercel

vercelBot commented May 25, 2026•
edited
Loading

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

ProjectDeploymentActionsUpdated (UTC)
docsify-previewReadyReadyPreview, CommentMay 26, 2026 3:37am

paulhibbitts
paulhibbitts previously approved these changes May 25, 2026
View reviewed changes

@paulhibbittspaulhibbitts left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for taking on this PR @sy-records ! I had a difficult time in trying to replicate search failures in codesandbox with a broken page so I created two GitHub Pages test repos based on the example provided by @kokovtsev after verifying locally.

Search index test (RC) - search for 'ipsum' fails:
https://github.com/paulhibbitts/docsify-v5-search-index-RC
https://paulhibbitts.github.io/docsify-v5-search-index-RC/#/

Search index test (PR preview build) - search for 'ipsum' succeeds:
https://github.com/paulhibbitts/docsify-v5-search-index-PR
https://paulhibbitts.github.io/docsify-v5-search-index-PR/#/

Hope you can also confirm these tests.

@sy-records

sy-records commented May 26, 2026

Copy link
Copy Markdown
MemberAuthor

That's right.

@sy-recordssy-records changed the title fix: improve data saving logic in search.jsfeat(search): support embedded content full-text search and tolerate broken linksMay 26, 2026
@sy-recordssy-records changed the title feat(search): support embedded content full-text search and tolerate broken linksfeat: support embedded content full-text search and tolerate broken linksMay 26, 2026
@sy-recordssy-records changed the title feat: support embedded content full-text search and tolerate broken linksfeat: improve indexing and embedded searchMay 26, 2026
paulhibbitts
paulhibbitts approved these changes May 26, 2026
View reviewed changes

@paulhibbittspaulhibbitts left a comment •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for addressing the embedded content search aspect in this PR as well @sy-records !

I've updated my two previous test repos.

Search index test (RC) - search for 'embedded' fails (removing the previous broken link test so search works again):
https://github.com/paulhibbitts/docsify-v5-search-index-RC
https://paulhibbitts.github.io/docsify-v5-search-index-RC/#/

Search index test (PR preview build) - search for 'embedded' succeeds:
https://github.com/paulhibbitts/docsify-v5-search-index-PR
https://paulhibbitts.github.io/docsify-v5-search-index-PR/#/

With the latest PR test build, both the broken link and embedded content search issues look fixed 👍🏼

@sy-records
sy-records merged commit ab96d74 into docsifyjs:developJun 3, 2026
8 checks passed
@sy-records
sy-records deleted the fix/2674 branch June 3, 2026 02:28
@sy-recordssy-records mentioned this pull request Jul 3, 2026
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@paulhibbittspaulhibbittspaulhibbitts approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Search indexing does not work if some links are broken Allow full text search on embedded content

2 participants

@sy-records@paulhibbitts