github/hugo-geekdoc
0
0
Fork 0
mirror of https://github.com/thegeeklab/hugo-geekdoc.git synced 2024-11-25 06:10:40 +00:00
Code Issues Projects Releases Wiki Activity

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

Browse Source 
Allow geekdocSearchShowParent
This commit is contained in:
Robert Kaussow 2020-11-10 22:59:44 +01:00 committed by GitHub
commit b8ea578df0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
assets/js/search-data.js
View File

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

5
assets/js/search.js
View File

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

10
exampleSite/content/usage/configuration.md
View File

@ -62,6 +62,11 @@ enableGitInfo = true
# Index is built on the fly and might slowdown your website. # Index is built on the fly and might slowdown your website.
geekdocSearch = false 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. # (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. # It can be either a remote url or a local file path relative to your content directory.
geekdocLegalNotice = "https://blog.example.com/legal" geekdocLegalNotice = "https://blog.example.com/legal"
@ -137,6 +142,11 @@ params:
# Index is built on the fly and might slowdown your website. # Index is built on the fly and might slowdown your website.
geekdocSearch: false 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. # (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. # It can be either a remote url or a local file path relative to your content directory.
geekdocLegalNotice: "https://blog.example.com/legal" geekdocLegalNotice: "https://blog.example.com/legal"