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 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) (limited to 'README.md') 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 = "" -- cgit v1.2.3 From 203d4932183de989a3f725458a60307b12c1c3e5 Mon Sep 17 00:00:00 2001 From: Jordan Kaye <jordan.kaye2@gmail.com> 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 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) (limited to 'README.md') 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 = "<img src=\"/images/github.png\"" + url = "https://github.com" + +You can optionally use the `post` var to include HTML after the `name` in the resulting links. +You can include useful menu links by including `"menu=main"` items in your `config.toml`. Example: [[menu.main]] name = "Hugo" post = "<span class='glyphicon glyphicon-fire'></span>" url = "http://gohugo.io" -You can optionally use the `pre` and `post` vars to include HTML before or after the `name` in the resulting links. +You can optionally use the `post` var to include HTML after the `name` in the resulting links. You can use the `"contact_email"` field in `[params]` to set a mailto: link the in the sidebar. Leave blank if you don't want it. -- cgit v1.2.3