Skip to content

include both page title and section header in search results #17877

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
merged 3 commits into from
Apr 27, 2023
Merged

include both page title and section header in search results #17877

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a8e1a50
separate title and section header
bgdeutsch Apr 25, 2023
ad9730f
always include section header in hierarchy
bgdeutsch Apr 27, 2023
8744168
Merge branch 'master' into brian.deutsch/integrations-search-result-h…
bgdeutsch Apr 27, 2023
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
3 changes: 2 additions & 1 deletion assets/scripts/components/algolia/getHitData.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ export function getHitData(hit) {
relpermalink: cleanRelPermalink,
category: hit.category ? hit.category : 'Documentation',
subcategory: hit.subcategory ? hit.subcategory : title,
title: hit.section_header ? hit.section_header : title,
title,
section_header: hit.section_header || null,
content: hit._highlightResult.content ? hit._highlightResult.content.value : ''
};
}
26 changes: 15 additions & 11 deletions assets/scripts/components/algolia/searchpageHits.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,20 @@ const renderHits = (renderOptions, isFirstRender) => {
container.querySelector('.ais-Hits-list').innerHTML = joinedListItemsHTML;
};

const getTitleHierarchyHTML = (hit) => {
const spacer = '<span class="ais-Hits-category-spacer">&#187;</span>'
const category = `<p class="ais-Hits-category">${hit.category}</p>`
const subcategory = `<p class="ais-Hits-subcategory">${hit.subcategory}</p>`
const pageTitle = `<p class="ais-Hits-title">${hit.title}</p>`
const baseTitleHierarchy = hit.subcategory === hit.title
? `${category}${spacer}${pageTitle}`
: `${category}${spacer}${subcategory}${spacer}${pageTitle}`

return hit.section_header
? `${baseTitleHierarchy}${spacer}<p class="ais-Hits-title">${hit.section_header}</p>`
: `${baseTitleHierarchy}`
}

// Returns a bunch of <li>s
const generateJoinedHits = (hitsArray) => {
return hitsArray
Expand All @@ -28,17 +42,7 @@ const renderHits = (renderOptions, isFirstRender) => {
return `
<li class="ais-Hits-item">
<a href="${cleanRelpermalink}" target="_blank" rel="noopener noreferrer">
<div class="ais-Hits-row">
<p class="ais-Hits-category">${hit.category}</p>

<span class="ais-Hits-category-spacer">&#187;</span>

${
hit.subcategory === hit.title
? `<p class="ais-Hits-title">${hit.title}</p>`
: `<p class="ais-Hits-subcategory">${hit.subcategory}</p><span class="ais-Hits-category-spacer">&#187;</span><p class="ais-Hits-title">${hit.title}</p>`
}
</div>
<div class="ais-Hits-row">${getTitleHierarchyHTML(item)}</div>
<div class="ais-Hits-row">
<p class="ais-Hits-content">${displayContent}</p>
</div>
Expand Down