aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNick Shine <shine.nick@gmail.com>2018-12-14 21:55:48 -0600
committerAlexander Shpak <alex-shpak@users.noreply.github.com>2018-12-20 21:07:15 +0100
commitd55e2ae921686b8ae79f8bcf827e8a292d6a5135 (patch)
tree8cf2263e080c0ad7f6436d962dfcb689d3686f22
parent74f9dbf0cdbc194beb947266a305b1861b771a10 (diff)
update README configuration with new last-modified feature
-rw-r--r--README.md16
1 files changed, 12 insertions, 4 deletions
diff --git a/README.md b/README.md
index 67fda63..53b779b 100644
--- a/README.md
+++ b/README.md
@@ -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
disablePathToLower: true
+# (Optional) Set this to true to enable 'Last Modified by' Git Author
+# information on 'doc' type pages.
+enableGitInfo: true
+
+
params:
# (Optional, default true) Show or hide table of contents globally
# 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
BookSection: docs
- # (Optional, uncomment and configure url to enable) Enable "Edit this page"
- # links for 'doc' page type. Path should point to 'content' directory of
- # source project.
- BookEditURL: https://github.com/alex-shpak/hugo-book/edit/master/exampleSite/content/
+ # Set source repository location.
+ # Used for 'Last Modified' and 'Edit this page' links.
+ BookRepo: https://github.com/alex-shpak/hugo-book
+
+ # 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