Skip to content

docs: make site search usable (scope to reader's language, stop one page filling results) #15745

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Maffooch merged 4 commits into from
Aug 20, 2026
+25 −1
Merged

docs: make site search usable (scope to reader's language, stop one page filling results) #15745

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7fdc751
docs: scope site search to the reader's language
devGregA Aug 20, 2026
bf05cd0
docs: stop one page from filling the search results
devGregA Aug 20, 2026
511bbb3
Merge branch 'bugfix' into devgrega/docs-search-language-filter
devGregA Aug 20, 2026
f51a338
Merge branch 'bugfix' into devgrega/docs-search-language-filter
Maffooch Aug 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion docs/assets/js/docsearch.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,34 @@
import docsearch from "@docsearch/js";

// Keep at most two hits from any one page. DocSearch groups results by section
// rather than by page, so a single long page can fill every slot: searching
// "reimport" returned five hits that were all subsections of the Reimport page,
// crowding out every other page in the docs.
const MAX_HITS_PER_PAGE = 2;

function limitHitsPerPage(items) {
const seen = new Map();
return items.filter(function (item) {
const page = item.url_without_anchor || item.url;
const n = (seen.get(page) || 0) + 1;
seen.set(page, n);
return n <= MAX_HITS_PER_PAGE;
});
}

// Scope results to the language of the page the reader is on. Every record in
// the index carries a `lang` facet and every page emits <html lang>, so without
// this filter an English reader gets German, Spanish, French and Japanese hits
// mixed into every search.
docsearch({
container: '#docsearch',
appId: '1JP5JYFGFC',
indexName: 'DefectDojo Docs',
apiKey: '213cc809a92717cffe6ffbe804d13fd1'
apiKey: '213cc809a92717cffe6ffbe804d13fd1',
searchParameters: {
facetFilters: ['lang:' + (document.documentElement.lang || 'en')]
},
transformItems: limitHitsPerPage
});

const onClick = function () {
Expand Down
Loading