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

update README configuration with new last-modified feature

Browse source
This commit is contained in:
Nick Shine 2018-12-14 21:55:48 -06:00 committed by Alexander Shpak
parent 74f9dbf0cd
commit d55e2ae921
1 changed files with 12 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -67,6 +67,11 @@ There are few configuration options you can add to your `config.yml|json|toml` f
# (Optional) Set this to true if you use captial letters in file names # (Optional) Set this to true if you use captial letters in file names
disablePathToLower: true disablePathToLower: true
# (Optional) Set this to true to enable 'Last Modified by' Git Author
# information on 'doc' type pages.
enableGitInfo: true
params: params:
# (Optional, default true) Show or hide table of contents globally # (Optional, default true) Show or hide table of contents globally
# You can also specify this parameter per page in front matter # You can also specify this parameter per page in front matter
@ -80,10 +85,13 @@ params:
# 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, uncomment and configure url to enable) Enable "Edit this page" # Set source repository location.
# links for 'doc' page type. Path should point to 'content' directory of # Used for 'Last Modified' and 'Edit this page' links.
# source project. BookRepo: https://github.com/alex-shpak/hugo-book
BookEditURL: https://github.com/alex-shpak/hugo-book/edit/master/exampleSite/content/
# Enable "Edit this page" links for 'doc' page type.
# Disabled by default. Uncomment to enable. Requires 'BookRepo' param.
BookEditPath: edit/master/exampleSite/content
``` ```
### Page Configuration ### Page Configuration