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

cleanup formatting

Browse Source
This commit is contained in:
Robert Kaussow 2020-11-11 11:48:25 +01:00
parent 5838f64644
commit b2e52d6073
No known key found for this signature in database
GPG Key ID: 65362AE74AF98B61
4 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -64,8 +64,8 @@ enableGitInfo = true
# (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
# 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.
@ -144,8 +144,8 @@ params:
# (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
# 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.
@ -180,8 +180,8 @@ weight = 10
# Set how many table of contents levels to be showed on page.
geekdocToC = 3
# Set a description for the current page. This will be shown in toc-trees objects
GeekdocDescription =
# Set a description for the current page. This will be shown in toc-trees objects.
geekdocDescription =
# Show a breadcrumb navigation bar at the top of each docs page.
geekdocBreadcrumb = false
@ -203,8 +203,8 @@ geekdocFlatSection = true
# Set true to hide page or section from side menu (file-tree menu only)
geekdocHidden = true
# Set false to show this page as a file-tree menu entry when you want it to be hidden in the sidebar
# NOTE: Only applies when geekdocHidden=true
# Set false to show this page as a file-tree menu entry when you want it to be hidden in the sidebar.
# NOTE: Only applies when 'geekdocHidden = true'.
geekdocHiddenTocTree = true
# Add an anchor link to headlines
@ -224,8 +224,8 @@ weight: 10
# Set how many table of contents levels to be showed on page.
geekdocToC: 3
# Set a description for the current page. This will be shown in toc-trees objects
GeekdocDescription:
# Set a description for the current page. This will be shown in toc-trees objects.
geekdocDescription:
# Show a breadcrumb navigation bar at the top of each docs page.
geekdocBreadcrumb: false
@ -247,8 +247,8 @@ geekdocFlatSection: true
# Set true to hide page or section from side menu (file-tree menu only)
geekdocHidden: true
# Set false to show this page as a file-tree menu entry when you want it to be hidden in the sidebar
# NOTE: Only applies when geekdocHidden=true
# Set false to show this page as a file-tree menu entry when you want it to be hidden in the sidebar.
# NOTE: Only applies when 'geekdocHidden: true'.
geekdocHiddenTocTree: true
# Add an anchor link to headlines

6
layouts/partials/menu-filetree.html
View File

@ -8,9 +8,9 @@
<ul class="gdoc-nav__list">
{{ range .sect.GroupBy "Weight" }}
{{ range .ByTitle }}
{{ if not .Params.geekdocHidden }}
{{ if not .Params.GeekdocHidden }}
<li>
{{ if or .Content .Params.geekdocFlatSection }}
{{ if or .Content .Params.GeekdocFlatSection }}
<span class="flex">
<a href="{{ .RelPermalink }}" class="gdoc-nav__entry {{ if eq $current . }}is-active{{ end }}">
{{ partial "title" . }}
@ -21,7 +21,7 @@
{{ end }}
{{ $numberOfPages := (add (len .Pages) (len .Sections)) }}
{{ if and (ne $numberOfPages 0) (not .Params.geekdocFlatSection) }}
{{ if and (ne $numberOfPages 0) (not .Params.GeekdocFlatSection) }}
{{ template "tree-nav" dict "sect" .Pages "current" $current}}
{{ end }}
</li>

2
layouts/partials/page-header.html
View File

@ -1,7 +1,7 @@
{{ $geekdocRepo := default (default false .Site.Params.GeekdocRepo) .Page.Params.GeekdocRepo }}
{{ $geekdocEditPath := default (default false .Site.Params.GeekdocEditPath) .Page.Params.GeekdocEditPath }}
{{ if .File }}
{{ $.Scratch.Set "geekdocFilePath" (default .File.Path .Page.Params.geekdocFilePath) }}
{{ $.Scratch.Set "geekdocFilePath" (default .File.Path .Page.Params.GeekdocFilePath) }}
{{ else }}
{{ $.Scratch.Set "geekdocFilePath" false }}
{{ end }}

6
layouts/shortcodes/toc-tree.html
View File

@ -11,9 +11,9 @@
<ul>
{{ range .sect.GroupBy "Weight" }}
{{ range .ByTitle }}
{{ if or (not .Params.geekdocHidden) (not (default true .Params.geekdocHiddenTocTree)) }}
{{ if or (not .Params.GeekdocHidden) (not (default true .Params.GeekdocHiddenTocTree)) }}
<li>
{{ if or .Content .Params.geekdocFlatSection }}
{{ if or .Content .Params.GeekdocFlatSection }}
<span>
<a href="{{ .RelPermalink }}" class="gdoc-toc__entry">{{ partial "title" . }}{{ with .Params.GeekdocDescription }}:</a> {{ . }}{{ else }}</a>{{ end }}
</span>
@ -22,7 +22,7 @@
{{ end }}
{{ $numberOfPages := (add (len .Pages) (len .Sections)) }}
{{ if and (ne $numberOfPages 0) (not .Params.geekdocFlatSection) }}
{{ if and (ne $numberOfPages 0) (not .Params.GeekdocFlatSection) }}
{{ template "toc-tree" dict "sect" .Pages }}
{{ end }}
</li>