Add search term highlight functionality in documentation

Description

Search terms need to be highlighted in the documentation. This requires some Java scripting in our docs template, as we would like this to happen in the documentation. 

Several options are available to do this. Most involve wrapping matched terms in mark up that we can style. Here are some of the threads I've discovered:

https://github.com/olivernn/lunr.js/issues/97

https://github.com/olivernn/lunr.js/issues/97#issuecomment-182813369

This comment has a demo implementation:

https://github.com/olivernn/lunr.js/issues/25#issuecomment-270369078

Demo: https://olivernn.github.io/moonwalkers/

 

 

Acceptance / Success Criteria

None

is triggered by

Lucidchart Diagrams

Activity

Show:

Jeff Gehlbach January 10, 2023 at 7:47 PM

I’m punting this one to the 31.0.4 release so that we can make the 31.0.3 release. We need to decide what is involved in testing the fix before we merge.

Bonnie Robinson August 30, 2022 at 12:55 PM

Suggestion that we reopen this issue to contribute these changes upstream so we don't lose them whenever we upgrade Antora. (See PR: https://github.com/OpenNMS/docs.opennms.com/pull/17)

 

fooker September 8, 2021 at 1:37 PM

Details

Assignee

Reporter

HB Grooming Date

HB Backlog Status

Story Points

Components

Sprint

Fix versions

Priority

PagerDuty

Created August 30, 2021 at 1:23 PM
Updated August 8, 2023 at 1:54 PM