From 6458a0b33c6259dee654c0c7100859f81ecc5627 Mon Sep 17 00:00:00 2001 From: Jordan Kaye Date: Sun, 13 Dec 2020 11:44:17 -0700 Subject: Fix deprecation warnings and correct README - Replace .Hugo and .RSSLink with their newer counterparts - sidebarDescription included in the README and example, but this parameter is not actually used. --- README.md | 10 ++-------- exampleSite/config.toml | 3 +-- layouts/partials/header.html | 6 +++--- 3 files changed, 6 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 5607188..b380692 100644 --- a/README.md +++ b/README.md @@ -38,18 +38,14 @@ Next, open the `config.toml` file in the base of the Hugo folder and ensure the There are various options you can easily set from your `config.toml` file. -This text will appear after the Title of your site in your `` meta tag: +This text will appear after the Title of your site in your `<title>` meta tag, and after the Title in the sidebar: description = "A Hugo Theme built with Bootstrap" ### Sidebar -This text will appear in the sidebar immediately under your site's Title: - - sidebarDescription = "A Hugo Theme built with Bootstrap" - -This text will appear in a free paragraph below the Title & sidebarDescription and above the menu links. Set it to "" if you don't want it. +This text will appear in a free paragraph below the Title & Description and above the menu links. Set it to "" if you don't want it. sidebarFreeText = "A optional paragraph of free text. Set to blank in config.toml to clear..." @@ -94,7 +90,6 @@ Using a theme is as simple as changing the `colorScheme` param in your `config.t colorScheme = "scheme-darkbrown" DateFormat = "2 Jan 2006" description = "A Hugo Theme built with Bootstrap" - sidebarDescription = "A Hugo Theme built with Bootstrap" sidebarFreeText = "A optional paragraph of free text. Set to blank in config.toml to clear..." @@ -150,7 +145,6 @@ Here is a full example `config.toml`: colorScheme = "scheme-darkbrown" DateFormat = "2 Jan 2006" description = "A blog about content" - sidebarDescription = "This is my blog about content" sidebarFreeText = "A optional paragraph of free text. Set to blank in config.toml to clear..." piwikSiteID = "" piwikURL = "" diff --git a/exampleSite/config.toml b/exampleSite/config.toml index 4c0e868..bad755e 100644 --- a/exampleSite/config.toml +++ b/exampleSite/config.toml @@ -13,7 +13,6 @@ theme = "strange-case" colorScheme = "scheme-darkbrown" dateformat = "Jan 2, 2006" description = "A Hugo Theme built with Bootstrap" - sidebarDescription = "A Hugo Theme built with Bootstrap" sidebarFreeText = "A optional paragraph of free text. Set to blank in config.toml to clear..." piwikSiteID = "" piwikURL = "" @@ -26,4 +25,4 @@ theme = "strange-case" [[menu.main]] name = "Bootstrap" post = "<span class='glyphicon glyphicon-ok'></span>" - url = "http://getbootstrap.com" \ No newline at end of file + url = "http://getbootstrap.com" diff --git a/layouts/partials/header.html b/layouts/partials/header.html index 34377c7..e76b8ed 100644 --- a/layouts/partials/header.html +++ b/layouts/partials/header.html @@ -4,7 +4,7 @@ <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> - {{ .Hugo.Generator }} + {{ hugo.Generator }}  <title>{{ .Title }} - {{ .Site.Params.description }} @@ -24,6 +24,6 @@ {{ "" | safeHTML }} - + - \ No newline at end of file + -- cgit v1.2.3 From 203d4932183de989a3f725458a60307b12c1c3e5 Mon Sep 17 00:00:00 2001 From: Jordan Kaye Date: Sun, 13 Dec 2020 13:29:20 -0700 Subject: Added a social icons section to the sidebar [[menu.icons]] can now be used to specify icons that will be displayed after the site's description, but before the main menu items. --- README.md | 12 ++++++++++-- layouts/partials/sidebar-content.html | 14 ++++++++++---- static/css/strange-case.css | 4 +++- 3 files changed, 23 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index b380692..874a365 100644 --- a/README.md +++ b/README.md @@ -49,14 +49,22 @@ This text will appear in a free paragraph below the Title & Description and abov sidebarFreeText = "A optional paragraph of free text. Set to blank in config.toml to clear..." -You can also include useful menu links by including `"menu=main"` items in your `config.toml`. Example: +You can include clickable icons (e.g. for social networks )by including `"menu=icons"` items in your `config.toml`. Example: + + [[menu.icons]] + name = "GitHub" + post = "

{{ end }} + + + {{ range .Site.Menus.main }} +

» {{ .Name }}{{ .Post }}

+ {{end}} +