allow nav title text

README.md

@@ -6,13 +6,15 @@ An accessibility-friendly Hugo theme, ported from the [original Cupper](https://
 
 ## Table of contents
 
+<!-- toc -->
+
 - [Demo](#demo)
 - [Minimum Hugo version](#minimum-hugo-version)
 - [Installation](#installation)
 - [Updating](#updating)
 - [Run example site](#run-example-site)
 - [Configuration](#configuration)
-- [Logo](#logo)
+- [Nav Title or Logo](#nav-title-or-logo)
 - [Favicons](#favicons)
 - [Shortcodes](#shortcodes)
 - [Syntax highlighting](#syntax-highlighting)
@@ -24,6 +26,8 @@ An accessibility-friendly Hugo theme, ported from the [original Cupper](https://
 - [Getting help](#getting-help)
 - [Credits](#credits)
 
+<!-- tocstop -->
+
 ## Demo
 
 https://cupper-hugo-theme.netlify.com/
@@ -60,9 +64,10 @@ hugo server --themesDir ../..
 
 Copy `config.yaml` from the [`exampleSite`](https://github.com/zwbetz-gh/cupper-hugo-theme/tree/master/exampleSite), then edit as desired.
 
-## Logo
+## Nav Title or Logo
 
-Place your SVG logo at `static/images/logo.svg`. If you don't provide a logo, then the default theme logo will be used. 
+- The `navTitleText` param will be checked in your config file. **If** this param exists, the text value will be used as the nav title
+- **Otherwise**, a logo will be used as the nav title. Place your **SVG** logo at `static/images/logo.svg`. If you don't provide a logo, then the default theme logo will be used
 
 ## Favicons
 

exampleSite/config.yaml

@@ -29,7 +29,8 @@ params:
   showThemeSwitcher: true
   defaultDarkTheme: false
   moveFooterToHeader: false
-  logoAlt: "An alternative text description of the logo"
+  # navTitleText: Cupper Theme
+  logoAlt: An alternative text description of the logo
   customCss:
     - css/custom_01.css
     - css/custom_02.css

layouts/partials/header.html

@@ -6,9 +6,14 @@
         href="{{ .Site.BaseURL }}"
         aria-label="{{ .Site.Title }} home page"
       >
+        {{ with .Site.Params.navTitleText }}
+          <h1>{{ . }}</h1>
+        {{ else }}
           <img 
             src="{{ "images/logo.svg" | relURL }}" 
-          alt="{{ .Site.Params.logoAlt | default "Logo" }}">
+            alt="{{ .Site.Params.logoAlt | default "Logo" }}"
+          >
+        {{ end }}
       </a>
       <p class="library-desc">
         {{ with .Site.Params.description }} {{ . | markdownify }} {{ end }}

task_regen_toc.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+markdown-toc -i README.md