summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlex Shpak <alex-shpak@users.noreply.github.com>2019-03-29 16:59:00 +0100
committerAlex Shpak <alex-shpak@users.noreply.github.com>2019-03-29 16:59:00 +0100
commit941ca77a327f595e50e0cd22d35e984afb29530d (patch)
tree94edc9227d22a7ee3dae9eae492b74cf603e4468 /README.md
parent5b652a1bb136accac19592614bf8b7cdcf18343b (diff)
Rename DateFormat to BookDateFormat, make format optional
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/README.md b/README.md
index a74c9b6..93269b2 100644
--- a/README.md
+++ b/README.md
@@ -101,9 +101,6 @@ enableGitInfo: true
disableKinds: ["taxonomy", "taxonomyTerm"]
params:
- # Configure the date format utilised on the pages - TODO, review git-footer.html
- DateFormat: "January 2, 2006"
-
# (Optional, default true) Show or hide table of contents globally
# You can also specify this parameter per page in front matter
BookShowToC: true
@@ -116,10 +113,10 @@ params:
# 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
+ # (Optional) 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.
+ # (Optional, default false) Include JS scripts in pages. Disabled by default.
# - Keep side menu on same scroll position during navigation
BookEnableJS: true
@@ -131,6 +128,11 @@ params:
# Disabled by default. Uncomment to enable. Requires 'BookRepo' param.
# Path must point to 'content' directory of repo.
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"
```