diff options
author | zwbetz-gh <zwbetz@gmail.com> | 2021-10-18 05:54:41 +0300 |
---|---|---|
committer | zwbetz-gh <zwbetz@gmail.com> | 2021-10-18 05:54:41 +0300 |
commit | ffdb78849edf02d5e6378fafe5b172150654901f (patch) | |
tree | 39a648ce84b3b58ab8aee97c310aaf0b7fc7f4ff | |
parent | 87e1a8608f44d46f6cc34fc54a4ddadbd2999433 (diff) |
allow nav title text
-rw-r--r-- | README.md | 17 | ||||
-rw-r--r-- | exampleSite/config.yaml | 3 | ||||
-rw-r--r-- | layouts/partials/header.html | 11 | ||||
-rw-r--r-- | static/.DS_Store | bin | 0 -> 6148 bytes | |||
-rwxr-xr-x | task_regen_toc.sh | 3 |
5 files changed, 24 insertions, 10 deletions
@@ -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/ @@ -58,15 +62,16 @@ hugo server --themesDir ../.. ## Configuration -Copy `config.yaml` from the [`exampleSite`](https://github.com/zwbetz-gh/cupper-hugo-theme/tree/master/exampleSite), then edit as desired. +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 -Upload your image to [RealFaviconGenerator](https://realfavicongenerator.net/) then copy-paste the generated favicon files under `static`. +Upload your image to [RealFaviconGenerator](https://realfavicongenerator.net/) then copy-paste the generated favicon files under `static`. ## Shortcodes @@ -133,4 +138,4 @@ If you run into an issue that isn't answered by this documentation or the [`exam ## Credits -Thank you to [Heydon Pickering](http://www.heydonworks.com) and [The Paciello Group](https://www.paciellogroup.com/) for creating the original Cupper project. +Thank you to [Heydon Pickering](http://www.heydonworks.com) and [The Paciello Group](https://www.paciellogroup.com/) for creating the original Cupper project. diff --git a/exampleSite/config.yaml b/exampleSite/config.yaml index 3a218e0..aee36bd 100644 --- a/exampleSite/config.yaml +++ b/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 diff --git a/layouts/partials/header.html b/layouts/partials/header.html index 245d510..e5d06ec 100644 --- a/layouts/partials/header.html +++ b/layouts/partials/header.html @@ -6,9 +6,14 @@ href="{{ .Site.BaseURL }}" aria-label="{{ .Site.Title }} home page" > - <img - src="{{ "images/logo.svg" | relURL }}" - alt="{{ .Site.Params.logoAlt | default "Logo" }}"> + {{ with .Site.Params.navTitleText }} + <h1>{{ . }}</h1> + {{ else }} + <img + src="{{ "images/logo.svg" | relURL }}" + alt="{{ .Site.Params.logoAlt | default "Logo" }}" + > + {{ end }} </a> <p class="library-desc"> {{ with .Site.Params.description }} {{ . | markdownify }} {{ end }} diff --git a/static/.DS_Store b/static/.DS_Store Binary files differnew file mode 100644 index 0000000..cd3a2cf --- /dev/null +++ b/static/.DS_Store diff --git a/task_regen_toc.sh b/task_regen_toc.sh new file mode 100755 index 0000000..3e8ddfb --- /dev/null +++ b/task_regen_toc.sh @@ -0,0 +1,3 @@ +#!/usr/bin/env bash + +markdown-toc -i README.md |