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

Experimental search highlighting and search sharing feature fails #2853

Closed
5 tasks done
dangiankit opened this issue Jul 21, 2021 · 12 comments
Closed
5 tasks done

Experimental search highlighting and search sharing feature fails #2853

dangiankit opened this issue Jul 21, 2021 · 12 comments

Comments

@dangiankit
Copy link

Contribution guidelines

I've found a bug and checked that ...

  • ... the problem doesn't occur with the mkdocs or readthedocs themes
  • ... the problem persists when all overrides are removed, i.e. custom_dir, extra_javascript and extra_css
  • ... the documentation does not mention anything about my problem
  • ... there are no open or closed issues that are related to my problem

Description

The search plugin's experimental features search.highlight and search.share don't seem to work as intended.

Expected behaviour

  1. Search highlighting would highlight the searched text on each search result by adding a mark tag around each search result which would eventually be highlighted either using Pygments or highlight.js. I even tried disabling CodeHilite in favor of the Highlight extension with Superfences extension along with mermaid2's custom fences but it didn't seem to work as intended.
  2. Search sharing icon would be seen on the Search box and would enable sharing of search term/results.

Actual behaviour

  1. No search highlighting on search results. mark tag not added.
  2. No search sharing icon seen.

Steps to reproduce

Take a look at this commit.

Package versions

  • Python: 3.8.10
  • MkDocs: 1.2.2
  • Material: 7.1.11

Configuration

https://github.com/dangiankit/kgtk/commit/2697d638c1a8e5b844872803d8bdce3d15aa933d

System information

  • Operating system: macOS BigSur v11.1, Darwin Kernel Version 20.2.0, x86_64
  • Browser: Google Chrome Version 91.0.4472.114 (Official Build) (x86_64)
@dangiankit
Copy link
Author

Looks like both of these are Insiders only or Exclusive features available to sponsors-only!

@squidfunk
Copy link
Owner

squidfunk commented Jul 21, 2021

That’s correct, currently both features are reserved to sponsors 😊

@dangiankit
Copy link
Author

dangiankit commented Jul 21, 2021

That’s correct, currently both features are reserved to sponsors 😊

@squidfunk How did I then have access to Search suggestions feature even before Biquinho Vermelho is met? Perhaps, there's an unintended leak? 🤔

@squidfunk
Copy link
Owner

squidfunk commented Jul 21, 2021

Search suggestions are rendered in grey text directly in the search bar behind the text you entered. I think you mean search results, which are rendered below the search bar, or not?

Bildschirmfoto 2021-07-21 um 15 19 25

@dangiankit
Copy link
Author

I mean, auto-suggest (the drop-down list) as compared to auto-complete.

@squidfunk
Copy link
Owner

Yeah, search suggestions are auto-complete, so maybe it's just confusing wording.

@dangiankit
Copy link
Author

Perhaps, this image would help.

@squidfunk
Copy link
Owner

It would be incorrect, because we're not rendering search suggestions below the search bar, but search results, i.e. the actual documents.

@squidfunk
Copy link
Owner

With the help of my awesome sponsors, I'm happy to tell you that we just reached the funding goal which will release those three features into the wild. Expect 7.2 within the next days, including all features from Biquinho Vermelho

@dangiankit
Copy link
Author

Awesome!

@squidfunk
Copy link
Owner

7.2.0 was just released.

@dangiankit
Copy link
Author

Thanks, @squidfunk -- that works!

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

No branches or pull requests

2 participants