Rename DateFormat to BookDateFormat, make format optional

5 files changed, 19 insertions, 12 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"
 ```
 
 
diff --git a/exampleSite/config.yml b/exampleSite/config.yml
index 0cf2eb7..d450485 100644
--- a/exampleSite/config.yml
+++ b/exampleSite/config.yml
@@ -15,9 +15,6 @@ pygmentsStyle: monokailight
 pygmentsCodeFences: true
 
 params:
-  # Configure the date format utilised on the pages
-  DateFormat: "Jan 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
@@ -45,3 +42,8 @@ params:
   # Disabled by default. Uncomment to enable. Requires 'BookRepo' param.
   # Path must point to 'content' directory of repo.
   BookEditPath: edit/master/exampleSite/content
+
+  # Configure the date format used on the pages
+  # - In git information
+  # - In blog posts
+  BookDateFormat: "Jan 2, 2006"
\ No newline at end of file
diff --git a/layouts/partials/docs/git-footer.html b/layouts/partials/docs/git-footer.html
index a8a126b..4a856d3 100644
--- a/layouts/partials/docs/git-footer.html
+++ b/layouts/partials/docs/git-footer.html
@@ -2,8 +2,9 @@
 <div class="align-center book-git-footer {{ if not .GitInfo }}justify-end{{ else }}justify-between{{ end }}">
   {{ with .GitInfo }}
   <div>
-    <a href="{{ $.Site.Params.BookRepo }}/commit/{{ .Hash }}" title='Last modified {{ .AuthorDate.Local.Format $.Site.Params.DateFormat }} by {{ .AuthorName }}' target="_blank" rel="noopener">
-      <img src="{{ "svg/code-merge.svg" | relURL }}" /> {{ .AuthorDate.Local.Format $.Site.Params.DateFormat }}
+    {{- $date := .AuthorDate.Local.Format (default "January 2, 2006" $.Site.Params.BookDateFormat) -}}
+    <a href="{{ $.Site.Params.BookRepo }}/commit/{{ .Hash }}" title='Last modified {{ $date }} by {{ .AuthorName }}' target="_blank" rel="noopener">
+      <img src="{{ "svg/code-merge.svg" | relURL }}" /> {{ $date }}
     </a>
   </div>
   {{ end }}
diff --git a/layouts/posts/list.html b/layouts/posts/list.html
index 9c68a79..18871f2 100644
--- a/layouts/posts/list.html
+++ b/layouts/posts/list.html
@@ -1,4 +1,5 @@
 {{ define "main" }}
+  {{- $dateFormat := default "January 2, 2006" .Site.Params.BookDateFormat -}}
   {{ $paginator := .Paginate (where .Pages "Params.hidden" "ne" true) }}
   {{ range sort .Paginator.Pages }}
   <article>
@@ -6,7 +7,7 @@
       <a href="{{ .RelPermalink }}">{{ .Title }}</a>
     </h2>
     <h5>
-      <strong>{{ .Date.Format .Site.Params.DateFormat }}</strong>
+      <strong>{{ .Date.Format $dateFormat }}</strong>
     </h5>
     <p class="markdown">
       {{- .Summary -}}
diff --git a/layouts/posts/single.html b/layouts/posts/single.html
index 36585e5..a7f94ed 100644
--- a/layouts/posts/single.html
+++ b/layouts/posts/single.html
@@ -1,8 +1,9 @@
 {{ define "main" }}
+{{- $dateFormat := default "January 2, 2006" .Site.Params.BookDateFormat -}}
 <header>
   <h1>{{ .Title }}</h1>
   <h5>
-    <strong>{{ .Date.Format .Site.Params.DateFormat  }}</strong>
+    <strong>{{ .Date.Format $dateFormat }}</strong>
   </h5>
 </header>
 <article class="markdown">