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

document minimal required page config

Browse Source
This commit is contained in:
Robert Kaussow 2020-04-15 01:10:49 +02:00
parent 204819124d
commit 7a527c8250
1 changed files with 40 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -4,6 +4,25 @@
{{< tab "TOML" >}} {{< tab "TOML" >}}
```Toml ```Toml
# ...
theme = hugo-geekdoc
# 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] [params]
# (Optional, default 6) Set how many table of contents levels to be showed on page. # (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/) # Use false to hide ToC, note that 0 will default to 6 (https://gohugo.io/functions/default/)
@ -64,6 +83,27 @@
{{< tab "YAML" >}} {{< tab "YAML" >}}
```Yaml ```Yaml
---
# ...
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: params:
# (Optional, default 6) Set how many table of contents levels to be showed on page. # (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/) # Use false to hide ToC, note that 0 will default to 6 (https://gohugo.io/functions/default/)