aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex Shpak <alex-shpak@users.noreply.github.com>2019-05-22 09:26:46 +0200
committerAlex Shpak <alex-shpak@users.noreply.github.com>2019-05-22 09:26:46 +0200
commit12f98cc2a59f915308963094c026c6ad58976a0e (patch)
tree3a0e697fca91b1bb47376ddd50ece0bffb481bb0
parent561fdd7b99717974fd3922e70542b07b850eba3b (diff)
#50, Add missing string literals in toml config
-rw-r--r--README.md18
1 files changed, 9 insertions, 9 deletions
diff --git a/README.md b/README.md
index ff58a21..bf76133 100644
--- a/README.md
+++ b/README.md
@@ -112,7 +112,7 @@ enableGitInfo = true
# (Warnings) Theme is intended for documentation use, there for it doesn't render taxonomy.
# You can hide related warning with config below
-disableKinds = ["taxonomy", "taxonomyTerm"]
+disableKinds = ['taxonomy', 'taxonomyTerm']
[params]
# (Optional, default true) Show or hide table of contents globally
@@ -121,14 +121,14 @@ BookShowToC = true
# (Optional, default none) Set leaf bundle to render as side menu
# When not specified file structure and weights will be used
-BookMenuBundle = /menu
+BookMenuBundle = '/menu'
# (Optional, default docs) Specify section of content to render as menu
# You can also set value to "*" to render all sections to menu
-BookSection = docs
+BookSection = 'docs'
# (Optional) This value is duplicate of $link-color for making active link highlight in menu bundle mode
-# BookMenuBundleActiveLinkColor = \#004ed0
+# BookMenuBundleActiveLinkColor = '\#004ed0'
# (Optional, default false) Include JS scripts in pages. Disabled by default.
# - Keep side menu on same scroll position during navigation
@@ -136,17 +136,17 @@ BookEnableJS = true
# Set source repository location.
# Used for 'Last Modified' and 'Edit this page' links.
-BookRepo = https://github.com/alex-shpak/hugo-book
+BookRepo = 'https://github.com/alex-shpak/hugo-book'
-# Enable "Edit this page" links for 'doc' page type.
+# Enable 'Edit this page' links for 'doc' page type.
# Disabled by default. Uncomment to enable. Requires 'BookRepo' param.
# Path must point to 'content' directory of repo.
-BookEditPath = edit/master/exampleSite/content
+BookEditPath = 'edit/master/exampleSite/content'
# (Optional, default January 2, 2006) Configure the date format used on the pages
# - In git information
# - In blog posts
-BookDateFormat = "Jan 2, 2006"
+BookDateFormat = 'Jan 2, 2006'
```
### Page Configuration
@@ -156,7 +156,7 @@ You can specify additional params per page in front matter
```md
+++
# Set type to 'docs' if you want to render page outside of configured section or if you render section other than 'docs'
-type = docs
+type = 'docs'
# Set page weight to re-arrange items in file-tree menu (if BookMenuBundle not set)
weight = 10