hugo-geekdoc/exampleSite/content/usage/configuration.md

244 lines
7.3 KiB
Markdown
Raw Normal View History

---
title: Configuration
weight: -10
---
## Site configuration
{{< tabs "site-config" >}}
{{< tab "TOML" >}}
```Toml
2020-04-14 23:10:49 +00:00
# ...
theme = 'hugo-geekdoc'
2020-04-14 23:10:49 +00:00
# Required to get well formatted code blocks
pygmentsUseClasses = true
pygmentsCodeFences = true
disablePathToLower = true
enableGitInfo = true
[markup]
[markup.goldmark.renderer]
# Needed for mermaid shortcode
unsafe = true
[markup.tableOfContents]
startLevel = 1
endLevel = 9
[params]
# (Optional, default 6) Set how many table of contents levels to be showed on page.
# Use false to hide ToC, note that 0 will default to 6 (https://gohugo.io/functions/default/)
# You can also specify this parameter per page in front matter.
geekdocToC = 3
# (Optional, default static/brand.svg) Set the path to a logo for the Geekdoc
# relative to your 'static/' folder.
geekdocLogo = logo.png
# (Optional, default false) Render menu from data file im 'data/menu/main.yaml'.
geekdocMenuBundle = true
# (Optional, default true) Show page navigation links at the bottom of each
# docs page (bundle menu only).
geekdocNextPrev = false
# (Optional, default true) Show a breadcrumb navigation bar at the top of each docs page.
# You can also specify this parameter per page in front matter.
geekdocBreadcrumb = false
# (Optional, default none) Set source repository location
# Used for 'Edit this page' links
# You can also specify this parameter per page in front matter.
geekdocRepo = 'https://github.com/xoxys/hugo'
# (Optional, default none) Enable "Edit this page" links. Requires 'GeekdocRepo' param
# and path must point to 'content' directory of repo.
# You can also specify this parameter per page in front matter.
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.
# Index is built on the fly and might slowdown your website.
geekdocSearch = false
# (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'
# (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.
geekdocPrivacyPolicy = '/privacy'
2020-02-26 23:08:00 +00:00
# (Optional, default true) Add an anchor link to headlines.
geekdocAnchor = true
2020-02-27 08:50:25 +00:00
# (Optional, default true) Copy anchor url to clipboard on click.
geekdocAnchorCopy = true
```
{{< /tab >}}
{{< tab "YAML" >}}
```Yaml
2020-04-14 23:10:49 +00:00
---
# ...
theme: hugo-geekdoc
# Required to get well formatted code blocks
pygmentsUseClasses: true
pygmentsCodeFences: true
disablePathToLower: true
enableGitInfo: true
markup:
goldmark:
# Needed for mermaid shortcode
renderer:
unsafe: true
tableOfContents:
startLevel: 1
endLevel: 9
params:
# (Optional, default 6) Set how many table of contents levels to be showed on page.
# Use false to hide ToC, note that 0 will default to 6 (https://gohugo.io/functions/default/)
# You can also specify this parameter per page in front matter.
geekdocToC: 3
# (Optional, default static/brand.svg) Set the path to a logo for the Geekdoc
# relative to your 'static/' folder.
geekdocLogo: logo.png
# (Optional, default false) Render menu from data file im 'data/menu/main.yaml'.
2020-01-14 21:42:16 +00:00
# See also https://geekdocs.de/usage/menus/#bundle-menu
geekdocMenuBundle: true
# (Optional, default true) Show page navigation links at the bottom of each
# docs page (bundle menu only).
geekdocNextPrev: false
# (Optional, default true) Show a breadcrumb navigation bar at the top of each docs page.
# You can also specify this parameter per page in front matter.
geekdocBreadcrumb: false
# (Optional, default none) Set source repository location
# Used for 'Edit this page' links
# You can also specify this parameter per page in front matter.
geekdocRepo: https://github.com/xoxys/hugo-geekdoc
# (Optional, default none) Enable "Edit this page" links. Requires 'GeekdocRepo' param
# and path must point to 'content' directory of repo.
# You can also specify this parameter per page in front matter.
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.
# Index is built on the fly and might slowdown your website.
geekdocSearch: false
# (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
# (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.
geekdocPrivacyPolicy: /privacy
2020-02-26 23:08:00 +00:00
# (Optional, default true) Add an anchor link to headlines.
geekdocAnchor: true
2020-02-27 08:50:25 +00:00
# (Optional, default true) Copy anchor url to clipboard on click.
geekdocAnchorCopy: true
```
{{< /tab >}}
{{< /tabs >}}
## Page configuration
{{< tabs "page-config" >}}
{{< tab "TOML" >}}
```Toml
# Set type to 'posts' if you want to render page as blogpost
type = 'posts'
# Set page weight to re-arrange items in file-tree menu
weight = 10
# Set how many table of contents levels to be showed on page.
geekdocToC = 3
# Show a breadcrumb navigation bar at the top of each docs page.
geekdocBreadcrumb = false
# Set source repository location
geekdocRepo = 'https://github.com/xoxys/hugo-geekdoc'
# Enable "Edit this page" links. Requires 'GeekdocRepo' param and path must point
# to 'content' directory of repo.
geekdocEditPath = 'edit/master/exampleSite/content'
# Used for 'Edit this page' link, set to '.File.Path' by default.
# Can be overwritten by a path relative to 'geekdocEditPath'
geekdocFilePath =
# Set to mark page as flat section (file-tree menu only)
geekdocFlatSection = true
# Set true to hide page or section from side menu (file-tree menu only)
geekdocHidden = true
2020-02-26 23:08:00 +00:00
# Add an anchor link to headlines
geekdocAnchor = true
```
{{< /tab >}}
{{< tab "YAML" >}}
```Yaml
# Set type to 'posts' if you want to render page as blogpost
type: 'posts'
# Set page weight to re-arrange items in file-tree menu
weight: 10
# Set how many table of contents levels to be showed on page.
geekdocToC: 3
# Show a breadcrumb navigation bar at the top of each docs page.
geekdocBreadcrumb: false
# Set source repository location
geekdocRepo: https://github.com/xoxys/hugo-geekdoc
# Enable "Edit this page" links. Requires 'GeekdocRepo' param and path must point
# to 'content' directory of repo.
geekdocEditPath: edit/master/exampleSite/content
# Used for 'Edit this page' link, set to '.File.Path' by default.
# Can be overwritten by a path relative to 'geekdocEditPath'
2020-01-13 23:30:58 +00:00
geekdocFilePath:
# Set to mark page as flat section (file-tree menu only)
geekdocFlatSection: true
# Set true to hide page or section from side menu (file-tree menu only)
geekdocHidden: true
2020-02-26 23:08:00 +00:00
# Add an anchor link to headlines
geekdocAnchor: true
```
{{< /tab >}}
{{< /tabs >}}