document minimal required page config

thegeeklab · Apr 14, 2020 · 7a527c8 · 7a527c8
1 parent 2048191
commit 7a527c8
Showing 1 changed file with 40 additions and 0 deletions.
diff --git a/exampleSite/content/usage/configuration.md b/exampleSite/content/usage/configuration.md
@@ -4,6 +4,25 @@
 {{< tab "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]
   # (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/)
@@ -64,6 +83,27 @@
 {{< tab "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:
   # (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/)