question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Experimental search highlighting and search sharing feature fails

See original GitHub issue

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)

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Comments:12 (6 by maintainers)

github_iconTop GitHub Comments

1reaction
squidfunkcommented, Jul 21, 2021

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

1reaction
squidfunkcommented, Jul 21, 2021

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

Read more comments on GitHub >

github_iconTop Results From Across the Web

Investigating the Effect of Snippet Text Highlighting in ...
In this paper, we try to find out whether the default strategy of highlighting query terms employed by most commercial search engines is...
Read more >
ElasticSearch Highlighting fails on match queries against ...
After indexing few documents, I am trying to query against the index to have suggestion like feature. The output of the query does...
Read more >
Do Not Highlight Stop Words in the Results of a Keyword ...
There is no value to highlighting words in the search results of a keyword search that were considered STOP words when the search...
Read more >
Search Highlights and Snippets
Quickly identify the best article and see how articles match your search terms with relevant text and highlighted search terms in the search...
Read more >
Improving GitHub code search
Today, we are rolling out a technology preview for GitHub code search, the next iteration for search, discovery, and navigation on GitHub.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found