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

fix docs for configuration

Browse Source
This commit is contained in:
Robert Kaussow 2020-09-17 22:45:20 +02:00
parent d4d8437388
commit 6eec8ac815
No known key found for this signature in database
GPG Key ID: 65362AE74AF98B61
2 changed files with 21 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
exampleSite/config.yaml
View File

@ -24,7 +24,6 @@ params:
geekdocRepo: https://github.com/xoxys/hugo-geekdoc geekdocRepo: https://github.com/xoxys/hugo-geekdoc
geekdocEditPath: edit/master/exampleSite/content geekdocEditPath: edit/master/exampleSite/content
geekdocDateFormat: "Jan 2, 2006"
geekdocSearch: true geekdocSearch: true
geekdocLegalNotice: https://thegeeklab.de/legal-notice/#contact-information geekdocLegalNotice: https://thegeeklab.de/legal-notice/#contact-information

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

@ -9,14 +9,13 @@ weight: -10
{{< tab "TOML" >}} {{< tab "TOML" >}}
```Toml ```Toml
# ... baseURL = "http://localhost"
title = "Geekdocs"
theme = 'hugo-geekdoc' theme = "hugo-geekdoc"
# Required to get well formatted code blocks # Required to get well formatted code blocks
pygmentsUseClasses = true pygmentsUseClasses = true
pygmentsCodeFences = true pygmentsCodeFences = true
disablePathToLower = true disablePathToLower = true
enableGitInfo = true enableGitInfo = true
@ -36,7 +35,7 @@ enableGitInfo = true
# (Optional, default static/brand.svg) Set the path to a logo for the Geekdoc # (Optional, default static/brand.svg) Set the path to a logo for the Geekdoc
# relative to your 'static/' folder. # relative to your 'static/' folder.
geekdocLogo = logo.png geekdocLogo = "logo.png"
# (Optional, default false) Render menu from data file im 'data/menu/main.yaml'. # (Optional, default false) Render menu from data file im 'data/menu/main.yaml'.
geekdocMenuBundle = true geekdocMenuBundle = true
@ -52,15 +51,12 @@ enableGitInfo = true
# (Optional, default none) Set source repository location # (Optional, default none) Set source repository location
# Used for 'Edit this page' links # Used for 'Edit this page' links
# You can also specify this parameter per page in front matter. # You can also specify this parameter per page in front matter.
geekdocRepo = 'https://github.com/xoxys/hugo' geekdocRepo = "https://github.com/xoxys/hugo"
# (Optional, default none) Enable "Edit this page" links. Requires 'GeekdocRepo' param # (Optional, default none) Enable 'Edit this page' links. Requires 'GeekdocRepo' param
# and path must point to 'content' directory of repo. # and path must point to 'content' directory of repo.
# You can also specify this parameter per page in front matter. # You can also specify this parameter per page in front matter.
geekdocEditPath = 'edit/master/exampleSite/content' geekdocEditPath = "edit/master/exampleSite/content"
# (Optional, default 'Jan 2, 2006') Configure the date format used on the pages in blog posts.
geekdocDateFormat = "Jan 2, 2006"
# (Optional, default true) Enables search function with flexsearch. # (Optional, default true) Enables search function with flexsearch.
# Index is built on the fly and might slowdown your website. # Index is built on the fly and might slowdown your website.
@ -68,11 +64,11 @@ enableGitInfo = 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"
# (Optional, default none) Add a link to your Privacy Policy page to the site footer. # (Optional, default none) Add a link to your Privacy Policy 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.
geekdocPrivacyPolicy = '/privacy' geekdocPrivacyPolicy = "/privacy"
# (Optional, default true) Add an anchor link to headlines. # (Optional, default true) Add an anchor link to headlines.
geekdocAnchor = true geekdocAnchor = true
@ -86,14 +82,13 @@ enableGitInfo = true
```Yaml ```Yaml
--- ---
# ... baseURL: "http://localhost"
title: "Geekdocs"
theme: hugo-geekdoc theme: "hugo-geekdoc"
# Required to get well formatted code blocks # Required to get well formatted code blocks
pygmentsUseClasses: true pygmentsUseClasses: true
pygmentsCodeFences: true pygmentsCodeFences: true
disablePathToLower: true disablePathToLower: true
enableGitInfo: true enableGitInfo: true
@ -131,27 +126,24 @@ params:
# (Optional, default none) Set source repository location # (Optional, default none) Set source repository location
# Used for 'Edit this page' links # Used for 'Edit this page' links
# You can also specify this parameter per page in front matter. # You can also specify this parameter per page in front matter.
geekdocRepo: https://github.com/xoxys/hugo-geekdoc geekdocRepo: "https://github.com/xoxys/hugo-geekdoc"
# (Optional, default none) Enable "Edit this page" links. Requires 'GeekdocRepo' param # (Optional, default none) Enable "Edit this page" links. Requires 'GeekdocRepo' param
# and path must point to 'content' directory of repo. # and path must point to 'content' directory of repo.
# You can also specify this parameter per page in front matter. # You can also specify this parameter per page in front matter.
geekdocEditPath: edit/master/exampleSite/content geekdocEditPath: edit/master/exampleSite/content
# (Optional, default 'Jan 2, 2006') Configure the date format used on the pages in blog posts.
geekdocDateFormat: "Jan 2, 2006"
# (Optional, default true) Enables search function with flexsearch. # (Optional, default true) Enables search function with flexsearch.
# 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 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"
# (Optional, default none) Add a link to your Privacy Policy page to the site footer. # (Optional, default none) Add a link to your Privacy Policy 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.
geekdocPrivacyPolicy: /privacy geekdocPrivacyPolicy: "/privacy"
# (Optional, default true) Add an anchor link to headlines. # (Optional, default true) Add an anchor link to headlines.
geekdocAnchor: true geekdocAnchor: true
@ -170,7 +162,7 @@ params:
```Toml ```Toml
# Set type to 'posts' if you want to render page as blogpost # Set type to 'posts' if you want to render page as blogpost
type = 'posts' type = "posts"
# Set page weight to re-arrange items in file-tree menu # Set page weight to re-arrange items in file-tree menu
weight = 10 weight = 10
@ -182,11 +174,11 @@ geekdocToC = 3
geekdocBreadcrumb = false geekdocBreadcrumb = false
# Set source repository location # Set source repository location
geekdocRepo = 'https://github.com/xoxys/hugo-geekdoc' geekdocRepo = "https://github.com/xoxys/hugo-geekdoc"
# Enable "Edit this page" links. Requires 'GeekdocRepo' param and path must point # Enable "Edit this page" links. Requires 'GeekdocRepo' param and path must point
# to 'content' directory of repo. # to 'content' directory of repo.
geekdocEditPath = 'edit/master/exampleSite/content' geekdocEditPath = "edit/master/exampleSite/content"
# Used for 'Edit this page' link, set to '.File.Path' by default. # Used for 'Edit this page' link, set to '.File.Path' by default.
# Can be overwritten by a path relative to 'geekdocEditPath' # Can be overwritten by a path relative to 'geekdocEditPath'
@ -207,7 +199,7 @@ geekdocAnchor = true
```Yaml ```Yaml
# Set type to 'posts' if you want to render page as blogpost # Set type to 'posts' if you want to render page as blogpost
type: 'posts' type: "posts"
# Set page weight to re-arrange items in file-tree menu # Set page weight to re-arrange items in file-tree menu
weight: 10 weight: 10
@ -219,11 +211,11 @@ geekdocToC: 3
geekdocBreadcrumb: false geekdocBreadcrumb: false
# Set source repository location # Set source repository location
geekdocRepo: https://github.com/xoxys/hugo-geekdoc geekdocRepo: "https://github.com/xoxys/hugo-geekdoc"
# Enable "Edit this page" links. Requires 'GeekdocRepo' param and path must point # Enable "Edit this page" links. Requires 'GeekdocRepo' param and path must point
# to 'content' directory of repo. # to 'content' directory of repo.
geekdocEditPath: edit/master/exampleSite/content geekdocEditPath: "edit/master/exampleSite/content"
# Used for 'Edit this page' link, set to '.File.Path' by default. # Used for 'Edit this page' link, set to '.File.Path' by default.
# Can be overwritten by a path relative to 'geekdocEditPath' # Can be overwritten by a path relative to 'geekdocEditPath'