Reformat search results metadata to be more verbose

alphagov · Nov 12, 2024 · 5f6b3ec · 5f6b3ec
1 parent 81cd431
commit 5f6b3ec
Show file tree

Hide file tree

Showing 3 changed files with 2 additions and 17 deletions.
diff --git a/lib/metalsmith-lunr-index/index.js b/lib/metalsmith-lunr-index/index.js
@@ -5,10 +5,6 @@ const navigationConfig = require('../../config/navigation')
 module.exports = function lunrPlugin() {
   return (files, metalsmith, done) => {
     const outputPath = 'search-index.json'
-
-    const separator =
-      '<span class="app-site-search__separator" aria-hidden="true">›</span>'
-
     const includedSections = navigationConfig
       .filter((section) => !section.ignoreInSearch)
       .map((section) => section.label)
@@ -88,7 +84,7 @@ module.exports = function lunrPlugin() {
         store[doc.permalink] = {
           permalink: doc.permalink,
           title: doc.title,
-          section: doc.section,
+          section: `in ${doc.section}`,
           aliases: doc.aliases
         }
         this.add(doc)
@@ -98,7 +94,7 @@ module.exports = function lunrPlugin() {
         store[doc.permalink] = {
           permalink: doc.permalink,
           title: doc.title,
-          section: `${doc.section}${separator}${doc.page}`,
+          section: `<span class="govuk-visually-hidden">,</span> part of ${doc.page} in ${doc.section}`,
           aliases: doc.aliases
         }
         this.add(doc)

diff --git a/src/javascripts/components/search.mjs b/src/javascripts/components/search.mjs
@@ -234,11 +234,6 @@ class Search extends Component {
       section.className = 'app-site-search--section'
       section.innerHTML = result.section
 
-      const visuallyHiddenComma = document.createElement('span')
-      visuallyHiddenComma.className = 'govuk-visually-hidden'
-      visuallyHiddenComma.innerHTML = ', '
-
-      elem.appendChild(visuallyHiddenComma)
       elem.appendChild(section)
       return elem.innerHTML
     }

diff --git a/src/stylesheets/components/_site-search.scss b/src/stylesheets/components/_site-search.scss
@@ -303,9 +303,3 @@ $icon-size: 40px;
     content: ")";
   }
 }
-
-.app-site-search__separator {
-  display: inline-block;
-  margin-right: govuk-spacing(1);
-  margin-left: govuk-spacing(1);
-}