Optional brand logo in the menu controlled by .Site.Params.BookLogo

- documentation in README.md and exampleSite/config.{toml,yaml}

README.md

@@ -127,6 +127,10 @@ disableKinds = ['taxonomy', 'taxonomyTerm']
 # You can also specify this parameter per page in front matter
 BookToC = 3
 
+# (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
 # When not specified file structure and weights will be used
 BookMenuBundle = '/menu'

assets/book.scss

@@ -93,6 +93,15 @@ ul.pagination {
 
 .book-brand {
   margin-top: 0;
+
+  img {
+    max-width: 40px;
+    max-height: 40px;
+    vertical-align: middle;
+  }
+  span {
+    margin-left: 0.5rem;
+  }
 }
 
 .book-menu {

exampleSite/config.toml

@@ -20,6 +20,10 @@ pygmentsCodeFences = true
   # You can also specify this parameter per page in front matter
   BookToC = 3
 
+  # (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
   # When not specified file structure and weights will be used
   BookMenuBundle = '/menu'

exampleSite/config.yaml

@@ -20,6 +20,10 @@ params:
   # You can also specify this parameter per page in front matter
   BookToC: 3
 
+  # (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
   # When not specified file structure and weights will be used
   BookMenuBundle: /menu

layouts/partials/docs/brand.html

@@ -1,3 +1,12 @@
 <h2 class="book-brand">
-  <a href="{{ .Site.BaseURL }}">{{ .Site.Title }}</a>
+  <a href="{{ .Site.BaseURL }}">
+    {{- with .Site.Params.BookLogo -}}
+      <img src="{{ . }}" alt="Logo" />
+      <span>
+    {{- end -}}
+    {{ .Site.Title }}
+    {{- with .Site.Params.BookLogo -}}
+      </span>
+    {{- end -}}
+  </a>
 </h2>