Uploaded image for project: 'OpenNMS'
  1. OpenNMS
  2. NMS-13540

Add search term highlight functionality in documentation

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Resolved (View Workflow)
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 28.1.1
    • Component/s: Documentation
    • Security Level: Default (Default Security Scheme)
    • Labels:
      None
    • Sprint:
      Horizon 2021 - Sep 1 - 15
    • HB Backlog Status:
      Backlog

      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/

       

       

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              fooker Dustin Frisch
              Reporter:
              Bonnie Bonnie Robinson
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:
                HB Grooming Date:

                  Git Integration