fix: exclude redundant search results

[wesleyboar]

Overview

Exclude redundant items from search.

Problem This Change Solves

Search normally shows results for content from all pages. But this repo includes pages (via include-markdown) into other pages. So when user searches "A", which is on page "X", which is included on page "Y"; then search results show page "X" and page "Y". In this repository, page "X" is usually not in the navigation, while page "Y" is. So, visiting page "X" from search results shows a page with no relevant navigation revealed.

How This Change Solves It

This change excludes all content from search that are on pages that are not directly included by navigation i.e. it excludes and pages included via include-markdown e.g. page "X" (an example described in "Problem This Change Solves").

Related

• mimics fix: exclude redundant search results TACC/TACC-Docs#62

Changed

• added a setting

Testing

1. Search for a phrase that is in the docs on a page that is included in another page.
2. See zero duplicate results.

UI

Before.Exclude.mov

The repeat headings in the results also have the same context; notice the smaller text underneath each duplicate heading.

After.Exclude.mov

The two "Description" results shown are from different context; notice the smaller text underneath each "Description".