Merge pull request #17 from atorrescogollo/feature/geekdocsearch-showparent

Allow geekdocSearchShowParent

assets/js/search-data.js

@@ -10,7 +10,7 @@
   indexCfg.doc = {
     id: 'id',
     field: ['title', 'content'],
-    store: ['title', 'href'],
+    store: ['title', 'href', 'parent'],
   };
 
   const index = FlexSearch.create(indexCfg);
@@ -21,6 +21,7 @@
     'id': {{ $index }},
     'href': '{{ $page.RelPermalink }}',
     'title': {{ (partial "title" $page) | jsonify }},
+    'parent': {{ with $page.Parent }}{{ (partial "title" .) | jsonify }}{{ else }}''{{ end }},
     'content': {{ $page.Plain | jsonify }}
   });
   {{- end -}}

assets/js/search.js

@@ -46,7 +46,12 @@
             a = li.appendChild(document.createElement('a'));
 
       a.href = page.href;
+
+      {{ if .Site.Params.GeekdocSearchShowParent }}
+      a.textContent = page.parent ? page.parent + ' / ' + page.title : page.title;
+      {{ else }}
       a.textContent = page.title;
+      {{ end }}
 
       results.appendChild(li);
       results.classList.add("DUMMY");

exampleSite/content/usage/configuration.md

@@ -62,6 +62,11 @@ enableGitInfo = true
   # Index is built on the fly and might slowdown your website.
   geekdocSearch = false
 
+  # (Optional, default false) Display search results with the parent folder as prefix. This
+  # option allows you to distinguish between files with the same name in different folders.
+  # NOTE: This parameter only applies when geekdocSearch=true
+  GeekdocSearchShowParent = true
+
   # (Optional, default none) Add a link to your Legal Notice page to the site footer.
   # It can be either a remote url or a local file path relative to your content directory.
   geekdocLegalNotice = "https://blog.example.com/legal"
@@ -137,6 +142,11 @@ params:
   # Index is built on the fly and might slowdown your website.
   geekdocSearch: false
 
+  # (Optional, default false) Display search results with the parent folder as prefix. This
+  # option allows you to distinguish between files with the same name in different folders.
+  # NOTE: This parameter only applies when geekdocSearch=true
+  GeekdocSearchShowParent: true
+
   # (Optional, default none) Add a link to your Legal Notice page to the site footer.
   # It can be either a remote url or a local file path relative to your content directory.
   geekdocLegalNotice: "https://blog.example.com/legal"