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

Align readme and config.yml

Browse source
This commit is contained in:
Alex Shpak 2019-02-20 00:27:25 +01:00
parent 4297ab1c08
commit d9961ece4e
2 changed files with 21 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -87,12 +87,19 @@ params:
# (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: /docs/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
# This value is duplicate of $link-color for making active link highlight in menu bundle mode
# BookMenuBundleActiveLinkColor: \#004ed0
# Include JS scripts in pages. Disabled by default.
# - Keep side menu on same scroll position during navigation
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

20
exampleSite/config.yml
View file

@ -1,6 +1,6 @@
# hugo server --themesDir ... # hugo server --themesDir ...
baseURL: https://example.com baseURL: https://example.com/example/
title: Hugo Book title: Hugo Book
theme: hugo-book theme: hugo-book
disableKinds: ["taxonomy", "taxonomyTerm"] disableKinds: ["taxonomy", "taxonomyTerm"]
@ -11,19 +11,24 @@ disablePathToLower: true
enableGitInfo: true enableGitInfo: true
params: params:
# show or hide table of contents for page # (Optional, default true) Show or hide table of contents globally
# You can also specify this parameter per page in front matter
BookShowToC: true BookShowToC: true
# Set bundle to render side menu # (Optional, default none) Set leaf bundle to render as side menu
# if 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
# You can also set value to "*" to render all sections to menu
BookSection: docs
# This value is duplicate of $link-color for making active link highlight in menu bundle mode # This value is duplicate of $link-color for making active link highlight in menu bundle mode
# BookMenuBundleActiveLinkColor: \#004ed0 # BookMenuBundleActiveLinkColor: \#004ed0
# specify section of content to render as menu # Include JS scripts in pages. Disabled by default.
# if bookMenuBundle is not set, 'docs' is value by default # - Keep side menu on same scroll position during navigation
BookSection: docs 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.
@ -31,4 +36,5 @@ params:
# 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.
BookEditPath: edit/master/exampleSite/content BookEditPath: edit/master/exampleSite/content