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.

Documentation search: tweak search term highlight design

See original GitHub issue

Follow-up to #6833 from Tom: https://github.com/wagtail/wagtail/pull/6833#issuecomment-786558723:

I dislike the standard RTD search term highlighting, and I usually remove the ?highlight=video param before sharing search results, e.g. in responses to support questions on Slack. I’d be in favour of removing that styling here - what do others think?

Here is the code that handles this. I think removing the highlight would just be a matter of removing this code: https://github.com/wagtail/wagtail/blob/23f146c7e115fc1daa342b6084ee94531cbe44dd/docs/_templates/search.html#L61-L64

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Reactions:1
  • Comments:7 (6 by maintainers)

github_iconTop GitHub Comments

6reactions
tomdysoncommented, Mar 9, 2021

Can we vote on this comment to gauge opinion?

👍🏼 = ‘we should keep highlighting’ 👎🏼 = ‘we should remove highlighting’

2reactions
Scotchestercommented, Mar 9, 2021

I think the feature is worth retaining. My query for Tom was whether less-jarring highlighting would appease his original concern. From his reply to this issue, it seems like it would.

I think you’re right, Thibaud, that it should be jarring enough not to be confused with regular formatting – I’m not sure just bolding would suffice – but whatever we land on, it does still need to meet minimum color contrast requirements.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Highlighting Search Terms - Cyril Mottier
In this article, I will introduce you to search results highlights, explain you why they are extremely helpful from a user point of...
Read more >
How to tweak Python Sphinx so that I can have a fine site ...
So I am wondering is there any trick so that I can have a better search performance from Sphinx search box? Also, is...
Read more >
Creating efficient searches for persistent highlighting
Creating efficient searches improves the performance of persistent highlighting, whether you're working with a Terms Search or Highlight Fields.
Read more >
Primo VE Customization - Best Practices
Analyzed search logs. Conducted surveys of librarians during workshops. Interviewed users at different academic levels and from various ...
Read more >
Influencing your title links in search results - Google Developers
Title links are critical to giving users a quick insight into the content of a result and why it's relevant to their query....
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