Provide a simple way to hide the highlighting of search results

[dbitouze]

Is your feature request related to a problem? Please describe.
I'm always frustrated when, after a search, the text is cluttered by the highlighting of search results (this is notably the case when what I'm looking for is a given document that I search with some words of its title).

Describe the solution you'd like
I'd like Furo to provide a simple way to hide the highlighting of search results as it is the case in the Sphinx-docdocumentation (see for instance at the bottom right of this page).

Describe alternatives you've considered
Some themes support this feature, for instance the Insipid Sphinx Theme as one can see at the top of this page (click on "Hide Search Matches").

[pradyunsg]

Ah interesting! It looks like a simple:

<a href="javascript:Documentation.hideSearchWords()">Hide Search Matches</a>

The big question is, where should this go on the page layout. :)

[dbitouze]

The big question is, where should this go on the page layout. :)

I like it at the top of the page (as with the Insipid Sphinx Theme) since you may want to look for a given document (searched with some words of its title) and not individual words. In such cases, you want to hide the searched words as soon as you reach the expected page.

Moreover, when it isn't at the top of the page, as it is the case in the Sphinx-doc documentation, the link that hides the searched words may be visible only if you scroll down, as in this page.

[pradyunsg]

Done in dfe43e8. Will cut a release next weekend.

[pradyunsg]

You can try it out here: https://pradyunsg.me/furo/reference/tables/?highlight=table