#455, add BookFavicon parameter

alex-shpak · Aug 8, 2023 · 16f6203 · 16f6203
1 parent 1cebd58
commit 16f6203
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 5 deletions.
diff --git a/exampleSite/config.toml b/exampleSite/config.toml
@@ -58,8 +58,12 @@ enableGitInfo = true
   # You can also specify this parameter per page in front matter.
   BookToC = true
 
-  # (Optional, default none) Set the path to a logo for the book. If the logo is
-  # /static/logo.png then the path would be logo.png
+  # (Optional, default favicon.png) Set the path to a favicon file.
+  # If the favicon is /static/favicon.png then the path would be favicon.png
+  # BookFavicon = 'favicon.png'
+
+  # (Optional, default none) Set the path to a logo for the book.
+  # If the logo is /static/logo.png then the path would be logo.png
   # BookLogo = 'logo.png'
 
   # (Optional, default none) Set leaf bundle to render as side menu

diff --git a/exampleSite/config.yaml b/exampleSite/config.yaml
@@ -54,8 +54,12 @@ params:
   # You can also specify this parameter per page in front matter.
   BookToC: true
 
-  # (Optional, default none) Set the path to a logo for the book. If the logo is
-  # /static/logo.png then the path would be logo.png
+  # (Optional, default favicon.png) Set the path to a favicon file.
+  # If the favicon is /static/favicon.png then the path would be favicon.png
+  # BookFavicon: "favicon.png"
+
+  # (Optional, default none) Set the path to a logo for the book.
+  # If the logo is /static/logo.png then the path would be logo.png
   # BookLogo: /logo.png
 
   # (Optional, default none) Set leaf bundle to render as side menu

diff --git a/layouts/partials/docs/html-head.html b/layouts/partials/docs/html-head.html
@@ -15,7 +15,7 @@
 
 {{- $manifest := resources.Get "manifest.json" | resources.ExecuteAsTemplate "manifest.json" . }}
 <link rel="manifest" href="{{ $manifest.RelPermalink }}">
-<link rel="icon" href="{{ "favicon.png" | relURL }}" type="image/x-icon">
+<link rel="icon" href="{{ .Params.BookFavicon | default "favicon.png" | relURL }}" >
 
 {{- range .Translations }}
   <link rel="alternate" hreflang="{{ default .Language.Lang .Site.LanguageCode }}" href="{{ .Permalink }}" title="{{ partial "docs/title" . }}">