adoralaura/hugo-book-theme
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

#50, Add missing string literals in toml config

Browse source
This commit is contained in:
Alex Shpak 2019-05-22 09:26:46 +02:00
parent 561fdd7b99
commit 12f98cc2a5
1 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -112,7 +112,7 @@ enableGitInfo = true
# (Warnings) Theme is intended for documentation use, there for it doesn't render taxonomy. # (Warnings) Theme is intended for documentation use, there for it doesn't render taxonomy.
# You can hide related warning with config below # You can hide related warning with config below
disableKinds = ["taxonomy", "taxonomyTerm"] disableKinds = ['taxonomy', 'taxonomyTerm']
[params] [params]
# (Optional, default true) Show or hide table of contents globally # (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 # (Optional, default none) Set leaf bundle to render as side menu
# When not specified file structure and weights will be used # 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 # (Optional, default docs) Specify section of content to render as menu
# You can also set value to "*" to render all sections to 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 # (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. # (Optional, default false) Include JS scripts in pages. Disabled by default.
# - Keep side menu on same scroll position during navigation # - Keep side menu on same scroll position during navigation
@ -136,17 +136,17 @@ BookEnableJS = true
# Set source repository location. # Set source repository location.
# Used for 'Last Modified' and 'Edit this page' links. # 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. # Disabled by default. Uncomment to enable. Requires 'BookRepo' param.
# Path must point to 'content' directory of repo. # 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 # (Optional, default January 2, 2006) Configure the date format used on the pages
# - In git information # - In git information
# - In blog posts # - In blog posts
BookDateFormat = "Jan 2, 2006" BookDateFormat = 'Jan 2, 2006'
``` ```
### Page Configuration ### Page Configuration
@ -156,7 +156,7 @@ You can specify additional params per page in front matter
```md ```md
+++ +++
# Set type to 'docs' if you want to render page outside of configured section or if you render section other than 'docs' # 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) # Set page weight to re-arrange items in file-tree menu (if BookMenuBundle not set)
weight = 10 weight = 10