feat: search ignore diacritical marks #1434

sy-records · 2020-11-30T01:00:56Z

Summary

search ignore diacritical marks

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

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)

resolve #1405

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

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 · 2020-11-30T01:01:01Z

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/fvsz0mwtj
✅ Preview: https://docsify-preview-git-fork-sy-records-feat-1405.docsify-core.now.sh

codesandbox-ci · 2020-11-30T01:02:52Z

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

Sandbox	Source
docsify-template	Configuration

sy-records · 2020-11-30T09:27:34Z

Unfortunately, normalize does not support IE.

Microsoft is also about to discontinue support for IE 11, do we still need to be IE compatible? cc @docsifyjs/reviewers

jhildenbiddle · 2020-12-01T18:22:01Z

@sy-records --

Given the near-universal support of normalize in other browsers, I think we can just mention the need for a ~~ponyfill~~ polyfill to support IE11 and provide a URL (below):

https://polyfill.io/v3/polyfill.min.js?features=String.prototype.normalize

We should verify that this ~~ponyfill~~ polyfill does in fact work, and specify that it needs to be included before any docsify-related <script> elements.

sy-records · 2020-12-02T01:00:36Z

I don't have IE11 to testing 😥

If we use this, do we want all users who need to search to add this polyfill?

jhildenbiddle · 2020-12-02T07:06:35Z

I can test in IE11 once the PR is ready.

As for the ~~ponyfill~~ polyfill, it should be optional. Docsify should feature check for normalize support and use it if available. If not, then the search plugin should function as it always has. The docs should suggest the ~~ponyfill~~ polyfill only for those concerned with diacritical marks and IE11 support. This way it's a non- breaking enhancement.

sy-records · 2020-12-02T10:04:49Z

@jhildenbiddle done

jhildenbiddle

Apologies for the slow response on this, @sy-records.

Verified working in modern browsers. Also verified working with and without polyfill in IE11. Great!

I did notice a few issues:

Search results are not displayed with their original diacritical marks. Notice in the screenshot below that the page contains the string "Let's go to café today". A search for "cafe" (no diacritical marks) matches "café" as it should, but the search result displayed under the search field shows the normalized version ("cafe") instead of the original text ("café").
Notice in the screenshot below that searching for "let" displays the matching search result text as "...Let's go to a cafe t...", but searching for "cafe" displays "...#39;s go to a cafe t...". That "#39;" looks like an incorrectly rendered HTML entity, but I haven't looked at the code to verify.
It looks like apostrophes break the search result highlighting.

FYI: Docsify is currently broken in IE11 due to issues with marked and the carbon ads plugin. I've already submitted fixes for marked (markedjs/marked#1877) and will address carbon ads soon. My tests in IE11 were done with a patched version of marked.

docs/plugins.md

sy-records · 2020-12-15T11:44:53Z

@jhildenbiddle Thanks for the test.

The third one is solved.

~~The second is an escapeHtml, I don t know how to deal with it for the time being.~~ Solve by removed.

~~The first question, I need to think about how to modify... 😂~~ That's it for now. If the original characters are used, the searched characters will not be selected, later we look at how to optimise the search plugin.

anikethsaha

one small suggestion.
Otherwise great stuff.

THanks @sy-records

anikethsaha · 2021-02-04T12:54:08Z

test/e2e/search.test.js

+    };
+    await docsifyInit(docsifyInitConfig);
+    await page.fill('input[type=search]', 'documentacion');
+    await expect(page).toEqualText('.results-panel h2', 'Que es');


is it possible to show the accent in the result ?

sorry if I missed any previous discussion regarding this. LMK

I don't have a good idea how to do it...

Looks like @sy-records got 2 of the 3 I listed. Perhaps we should open a new issue regarding missing diacritical marks in the search results so we can merge and release this PR.

done. #1491

Created a new issue for missing diacritical remarks in search results (#1492).

jhildenbiddle

LGTM

feat: search ignore diacritical marks

2975d8c

vercel bot deployed to Preview November 30, 2020 01:01 View deployment

sy-records requested review from jhildenbiddle, anikethsaha, Koooooo-7 and trusktr November 30, 2020 01:01

sy-records marked this pull request as draft November 30, 2020 09:26

Merge branch 'develop' into feat/1405

d23285e

vercel bot deployed to Preview November 30, 2020 09:33 View deployment

sy-records marked this pull request as ready for review November 30, 2020 10:04

sy-records marked this pull request as draft December 2, 2020 07:42

Check if normalize is supported

2102b69

vercel bot deployed to Preview December 2, 2020 09:56 View deployment

sy-records marked this pull request as ready for review December 2, 2020 10:04

jhildenbiddle requested changes Dec 15, 2020

View reviewed changes

docs/plugins.md Outdated Show resolved Hide resolved

Merge branch 'develop' into feat/1405

22d780c

vercel bot deployed to Preview December 15, 2020 08:21 View deployment

Update docs

803e6b6

vercel bot deployed to Preview December 15, 2020 08:23 View deployment

vercel bot deployed to Preview December 15, 2020 11:15 View deployment

Fix escape

6d0a1bf

sy-records force-pushed the feat/1405 branch from 3c38fb1 to 6d0a1bf Compare December 15, 2020 11:18

vercel bot deployed to Preview December 15, 2020 11:18 View deployment

Merge branch 'develop' into feat/1405

115f0e4

vercel bot deployed to Preview December 25, 2020 07:25 View deployment

remove escapeHtml

91f8d79

vercel bot deployed to Preview December 25, 2020 10:59 View deployment

sy-records requested a review from jhildenbiddle December 27, 2020 01:23

anikethsaha requested changes Feb 4, 2021

View reviewed changes

jhildenbiddle requested a review from anikethsaha February 5, 2021 05:05

jhildenbiddle approved these changes Feb 5, 2021

View reviewed changes

Merge branch 'develop' into feat/1405

9668613

vercel bot deployed to Preview February 5, 2021 05:05 View deployment

sy-records mentioned this pull request Feb 5, 2021

is it possible to show the accent in the result ? #1491

Closed

jhildenbiddle mentioned this pull request Feb 5, 2021

Search results remove search string's diacritical marks #1492

Closed

1 task

sy-records merged commit 8968a74 into docsifyjs:develop Feb 5, 2021

sy-records deleted the feat/1405 branch February 5, 2021 05:40

sy-records mentioned this pull request Feb 5, 2021

[Release]: v4.12.0 #1493

Merged

3 tasks

anikethsaha mentioned this pull request Feb 19, 2021

[Snyk] Security upgrade docsify from 4.11.6 to 4.12.0 #1518

Merged

sy-records mentioned this pull request Apr 1, 2021

fix: Add escapeHtml for search #1551

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: search ignore diacritical marks #1434

feat: search ignore diacritical marks #1434

sy-records commented Nov 30, 2020

vercel bot commented Nov 30, 2020 •

edited

Loading

codesandbox-ci bot commented Nov 30, 2020 •

edited

Loading

sy-records commented Nov 30, 2020 •

edited

Loading

jhildenbiddle commented Dec 1, 2020 •

edited

Loading

sy-records commented Dec 2, 2020

jhildenbiddle commented Dec 2, 2020 •

edited

Loading

sy-records commented Dec 2, 2020

jhildenbiddle left a comment •

edited

Loading

sy-records commented Dec 15, 2020 •

edited

Loading

anikethsaha left a comment

anikethsaha Feb 4, 2021

sy-records Feb 5, 2021

jhildenbiddle Feb 5, 2021

sy-records Feb 5, 2021

jhildenbiddle Feb 5, 2021

jhildenbiddle left a comment

feat: search ignore diacritical marks #1434

feat: search ignore diacritical marks #1434

Conversation

sy-records commented Nov 30, 2020

vercel bot commented Nov 30, 2020 • edited Loading

codesandbox-ci bot commented Nov 30, 2020 • edited Loading

sy-records commented Nov 30, 2020 • edited Loading

jhildenbiddle commented Dec 1, 2020 • edited Loading

sy-records commented Dec 2, 2020

jhildenbiddle commented Dec 2, 2020 • edited Loading

sy-records commented Dec 2, 2020

jhildenbiddle left a comment • edited Loading

Choose a reason for hiding this comment

sy-records commented Dec 15, 2020 • edited Loading

anikethsaha left a comment

Choose a reason for hiding this comment

anikethsaha Feb 4, 2021

Choose a reason for hiding this comment

sy-records Feb 5, 2021

Choose a reason for hiding this comment

jhildenbiddle Feb 5, 2021

Choose a reason for hiding this comment

sy-records Feb 5, 2021

Choose a reason for hiding this comment

jhildenbiddle Feb 5, 2021

Choose a reason for hiding this comment

jhildenbiddle left a comment

Choose a reason for hiding this comment

vercel bot commented Nov 30, 2020 •

edited

Loading

codesandbox-ci bot commented Nov 30, 2020 •

edited

Loading

sy-records commented Nov 30, 2020 •

edited

Loading

jhildenbiddle commented Dec 1, 2020 •

edited

Loading

jhildenbiddle commented Dec 2, 2020 •

edited

Loading

jhildenbiddle left a comment •

edited

Loading

sy-records commented Dec 15, 2020 •

edited

Loading