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

feat: add option geekdocProtected to exclude pages from data file (#97)

Browse Source
This commit is contained in:
Robert Kaussow 2021-04-22 21:25:43 +02:00 committed by GitHub
parent 4e81dbe0e9
commit d51f514b90
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
assets/search-data.json
View File

@ -1,5 +1,5 @@
[ [
{{ range $index, $page := .Site.Pages }} {{ range $index, $page := (where .Site.Pages "Params.geekdocprotected" "ne" true) }}
{{ if ne $index 0 }},{{ end }} {{ if ne $index 0 }},{{ end }}
{ {
"id": {{ $index }}, "id": {{ $index }},

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

@ -230,6 +230,12 @@ geekdocCollapseSection = true
# Add an anchor link to headlines. # Add an anchor link to headlines.
geekdocAnchor = true geekdocAnchor = true
# If you have protected some pages with e.g. basic authentication you may want to exclude these pages
# from data file, otherwise information may be leaked. Setting this parameter to 'true' will exclude the
# page from search data, feeds, etc.
# WARNING: Consider hosting a standalone, fully auth-protected static page for secret information instead!
geekdocProtected: false
``` ```
{{< /tab >}} {{< /tab >}}
@ -277,6 +283,12 @@ geekdocCollapseSection: true
# Add an anchor link to headlines. # Add an anchor link to headlines.
geekdocAnchor: true geekdocAnchor: true
# If you have protected some pages with e.g. basic authentication you may want to exclude these pages
# from data file, otherwise information may be leaked. Setting this parameter to 'true' will exclude the
# page from search data, feeds, etc.
# WARNING: Consider hosting a standalone, fully auth-protected static page for secret information instead!
geekdocProtected: false
``` ```
{{< /tab >}} {{< /tab >}}