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

387 lines
14 KiB
Markdown
Raw Normal View History

---
title: Configuration
weight: -10
---
{{< toc >}}
## Site configuration
{{< tabs "site-config" >}}
{{< tab "TOML" >}}
```toml
2020-09-17 20:45:20 +00:00
baseURL = "http://localhost"
title = "Geekdocs"
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
2021-09-08 19:48:31 +00:00
# Required if you want to render robots.txt template
enableRobotsTXT = true
2020-04-14 23:10:49 +00:00
[markup]
[markup.goldmark.renderer]
# Needed for mermaid shortcode
unsafe = true
[markup.tableOfContents]
startLevel = 1
endLevel = 9
2021-09-01 08:18:00 +00:00
[taxonomies]
tag = "tags"
[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.
2020-09-17 20:45:20 +00:00
geekdocLogo = "logo.png"
# (Optional, default false) Render menu from data file in 'data/menu/main.yaml'.
2021-11-24 08:10:26 +00:00
# See also https://geekdocs.de/usage/menus/#bundle-menu.
geekdocMenuBundle = true
2021-11-24 08:10:26 +00:00
# (Optional, default false) Collapse all menu entries, can not be overwritten
# per page if enabled. Can be enabled per page via 'geekdocCollapseSection'.
2021-11-24 08:10:26 +00:00
geekdocCollapseAllSections = true
# (Optional, default true) Show page navigation links at the bottom of each docs page.
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 page' links.
# You can also specify this parameter per page in front matter.
2020-09-27 20:21:29 +00:00
geekdocRepo = "https://github.com/thegeeklab/hugo"
# (Optional, default none) Enable 'Edit page' links. Requires 'geekdocRepo' param
# and the path must point to the parent directory of the 'content' folder.
# You can also specify this parameter per page in front matter.
geekdocEditPath = "edit/main/exampleSite"
2022-01-06 21:52:22 +00:00
# (Optional, default true) Enables search function with flexsearch.
# Index is built on the fly and might slow down your website.
geekdocSearch = false
2020-11-10 21:50:21 +00:00
# (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.
2020-11-11 10:48:25 +00:00
# NOTE: This parameter only applies when 'geekdocSearch = true'.
geekdocSearchShowParent = true
2020-11-10 21:50:21 +00:00
# (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.
2020-09-17 20:45:20 +00:00
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.
2020-09-17 20:45:20 +00:00
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
2021-02-20 20:39:31 +00:00
# (Optional, default true) Enable or disable image lazy loading for images rendered
# by the 'img' shortcode.
geekdocImageLazyLoading = true
2021-05-23 20:30:22 +00:00
# (Optional, default false) Set HTMl <base> to .Site.BaseURL if enabled. It might be required
# if a subdirectory is used within Hugos BaseURL.
# See https://developer.mozilla.org/de/docs/Web/HTML/Element/base.
geekdocOverwriteHTMLBase = false
2021-04-27 21:44:35 +00:00
# (Optional, default true) Enable or disable the JavaScript based color theme toggle switch. The CSS based
# user preference mode still works.
geekdocDarkModeToggle = false
2021-04-27 21:44:35 +00:00
# (Optional, default false) Auto-decrease brightness of images and add a slightly grayscale to avoid
# bright spots while using the dark mode.
geekdocDarkModeDim = false
# (Optional, default false) Enforce code blocks to always use the dark color theme.
geekdocDarkModeCode = false
# (Optional, default true) Display a "Back to top" link in the site footer.
geekdocBackToTop = true
2021-09-01 08:18:00 +00:00
# (Optional, default false) Enable or disable adding tags for post pages automatically to the navigation sidebar.
geekdocTagsToMenu = true
# (Optional, default 'title') Configure how to sort file-tree menu entries. Possible options are 'title', 'linktitle',
# 'date', 'publishdate', 'expirydate' or 'lastmod'. Every option can be used with a reverse modifier as well
# e.g. 'title_reverse'.
geekdocFileTreeSortBy = "title"
# (Optional, default none) Adds a "Content licensed under <license>" line to the footer.
# Could be used if you want to define a default license for your content.
[params.geekdocContentLicense]
name = "CC BY-SA 4.0"
link = "https://creativecommons.org/licenses/by-sa/4.0/"
```
{{< /tab >}}
{{< tab "YAML" >}}
```yaml
2020-04-14 23:10:49 +00:00
---
2020-09-17 20:45:20 +00:00
baseURL: "http://localhost"
title: "Geekdocs"
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
2021-09-08 19:48:31 +00:00
# Required if you want to render robots.txt template
enableRobotsTXT: true
2020-04-14 23:10:49 +00:00
markup:
goldmark:
# Needed for mermaid shortcode
renderer:
unsafe: true
tableOfContents:
startLevel: 1
endLevel: 9
2021-09-01 08:18:00 +00:00
taxonomies:
tag: tags
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 in 'data/menu/main.yaml'.
2021-11-24 08:10:26 +00:00
# See also https://geekdocs.de/usage/menus/#bundle-menu.
geekdocMenuBundle: true
# (Optional, default false) Collapse all menu entries, can not be overwritten
# per page if enabled. Can be enabled per page via 'geekdocCollapseSection'.
geekdocCollapseAllSections: true
# (Optional, default true) Show page navigation links at the bottom of each docs page.
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 page' links.
# You can also specify this parameter per page in front matter.
2020-09-27 20:21:29 +00:00
geekdocRepo: "https://github.com/thegeeklab/hugo-geekdoc"
# (Optional, default none) Enable 'Edit page' links. Requires 'geekdocRepo' param
# and the path must point to the parent directory of the 'content' folder.
# You can also specify this parameter per page in front matter.
geekdocEditPath: edit/main/exampleSite
2022-01-06 21:52:22 +00:00
# (Optional, default true) Enables search function with flexsearch.
# Index is built on the fly and might slow down your website.
geekdocSearch: false
2020-11-10 21:50:21 +00:00
# (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.
2020-11-11 10:48:25 +00:00
# NOTE: This parameter only applies when 'geekdocSearch: true'.
geekdocSearchShowParent: true
2020-11-10 21:50:21 +00:00
# (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.
2020-09-17 20:45:20 +00:00
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.
2020-09-17 20:45:20 +00:00
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
2021-02-20 20:39:31 +00:00
# (Optional, default true) Enable or disable image lazy loading for images rendered
# by the 'img' shortcode.
geekdocImageLazyLoading: true
2021-05-23 20:30:22 +00:00
# (Optional, default false) Set HTMl <base> to .Site.BaseURL if enabled. It might be required
# if a subdirectory is used within Hugos BaseURL.
# See https://developer.mozilla.org/de/docs/Web/HTML/Element/base.
geekdocOverwriteHTMLBase: false
2021-04-27 21:44:35 +00:00
# (Optional, default true) Enable or disable the JavaScript based color theme toggle switch. The CSS based
# user preference mode still works.
geekdocDarkModeToggle: false
2021-04-27 21:44:35 +00:00
# (Optional, default false) Auto-decrease brightness of images and add a slightly grayscale to avoid
# bright spots while using the dark mode.
geekdocDarkModeDim: false
# (Optional, default false) Enforce code blocks to always use the dark color theme.
geekdocDarkModeCode: false
# (Optional, default true) Display a "Back to top" link in the site footer.
geekdocBackToTop: true
2021-09-01 08:18:00 +00:00
# (Optional, default false) Enable or disable adding tags for post pages automatically to the navigation sidebar.
geekdocTagsToMenu: true
# (Optional, default 'title') Configure how to sort file-tree menu entries. Possible options are 'title', 'linktitle',
# 'date', 'publishdate', 'expirydate' or 'lastmod'. Every option can be used with a reverse modifier as well
# e.g. 'title_reverse'.
geekdocFileTreeSortBy: "title"
# (Optional, default none) Adds a "Content licensed under <license>" line to the footer.
# Could be used if you want to define a default license for your content.
geekdocContentLicense:
name: CC BY-SA 4.0
link: https://creativecommons.org/licenses/by-sa/4.0/
```
{{< /tab >}}
{{< /tabs >}}
## Page configuration
{{< tabs "page-config" >}}
{{< tab "TOML" >}}
```toml
# Set type to 'posts' if you want to render page as blogpost
2020-09-17 20:45:20 +00:00
type = "posts"
# Hugo predefined front matter variable, to re-arrange items in file-tree menu
# See weights section of
# https://gohugo.io/content-management/front-matter/#predefined
weight = 10
# Set how many table of contents levels to be showed on page.
geekdocToC = 3
2020-11-11 10:48:25 +00:00
# Set a description for the current page. This will be shown in toc-trees objects.
geekdocDescription =
# Set false to hide the whole left navigation sidebar. Beware that it will make
# navigation pretty hard without adding some kind of on-page navigation.
geekdocNav = true
# Show a breadcrumb navigation bar at the top of each docs page.
geekdocBreadcrumb = false
2021-01-24 11:04:40 +00:00
# Set source repository location.
2020-09-27 20:21:29 +00:00
geekdocRepo = "https://github.com/thegeeklab/hugo-geekdoc"
# Enable 'Edit page' links. Requires 'geekdocRepo' param and the path must point to
# the parent directory of the 'content' folder.
geekdocEditPath = "edit/main/exampleSite"
# Used for 'Edit page' link, set to '.File.Path' by default.
# Can be overwritten by a path relative to 'geekdocEditPath'
geekdocFilePath =
2021-01-24 11:04:40 +00:00
# Set to mark page as flat section (file-tree menu only).
geekdocFlatSection = true
2021-01-24 11:04:40 +00:00
# Set true to hide page or section from side menu (file-tree menu only).
geekdocHidden = true
2020-02-26 23:08:00 +00:00
2020-11-11 10:48:25 +00:00
# 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
2021-01-24 11:04:40 +00:00
# Set to true to make a section foldable in side menu.
geekdocCollapseSection = true
2021-01-24 11:04:40 +00:00
# Add an anchor link to headlines.
2020-02-26 23:08:00 +00:00
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!
2021-05-13 13:17:18 +00:00
geekdocProtected = false
# Set 'left' (default), 'center' or 'right' to configure the text align of a page.
geekdocAlign = "left"
```
{{< /tab >}}
{{< tab "YAML" >}}
```yaml
2021-01-24 11:04:40 +00:00
# Set type to 'posts' if you want to render page as blogpost.
2020-09-17 20:45:20 +00:00
type: "posts"
2021-01-24 11:04:40 +00:00
# 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
2020-11-11 10:48:25 +00:00
# Set a description for the current page. This will be shown in toc-trees objects.
geekdocDescription:
# Set false to hide the whole left navigation sidebar. Beware that it will make
# navigation pretty hard without adding some kind of on-page navigation.
geekdocNav: true
# Show a breadcrumb navigation bar at the top of each docs page.
geekdocBreadcrumb: false
2021-01-24 11:04:40 +00:00
# Set source repository location.
2020-09-27 20:21:29 +00:00
geekdocRepo: "https://github.com/thegeeklab/hugo-geekdoc"
# Enable 'Edit page' links. Requires 'geekdocRepo' param and the path must point to
# the parent directory of the 'content' folder.
geekdocEditPath: "edit/main/exampleSite"
# Used for 'Edit 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:
2021-01-24 11:04:40 +00:00
# Set to mark page as flat section (file-tree menu only).
geekdocFlatSection: true
2021-01-24 11:04:40 +00:00
# Set true to hide page or section from side menu (file-tree menu only).
geekdocHidden: true
2020-02-26 23:08:00 +00:00
2020-11-11 10:48:25 +00:00
# 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
2021-01-24 11:04:40 +00:00
# Set to true to make a section foldable in side menu.
geekdocCollapseSection: true
2021-01-24 11:04:40 +00:00
# Add an anchor link to headlines.
2020-02-26 23:08:00 +00:00
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
# Set 'left' (default), 'center' or 'right' to configure the text align of a page.
geekdocAlign: "left"
```
{{< /tab >}}
{{< /tabs >}}