Skip to content

Commit 6458a0b

Browse files
committed
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.
1 parent 26404ab commit 6458a0b

File tree

3 files changed

+6
-13
lines changed

3 files changed

+6
-13
lines changed

README.md

+2-8
Original file line numberDiff line numberDiff line change
@@ -38,18 +38,14 @@ Next, open the `config.toml` file in the base of the Hugo folder and ensure the
3838

3939
There are various options you can easily set from your `config.toml` file.
4040

41-
This text will appear after the Title of your site in your `<title>` meta tag:
41+
This text will appear after the Title of your site in your `<title>` meta tag, and after the Title in the sidebar:
4242

4343
description = "A Hugo Theme built with Bootstrap"
4444

4545

4646
### Sidebar
4747

48-
This text will appear in the sidebar immediately under your site's Title:
49-
50-
sidebarDescription = "A Hugo Theme built with Bootstrap"
51-
52-
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.
48+
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.
5349

5450
sidebarFreeText = "A optional paragraph of free text. Set to blank in config.toml to clear..."
5551

@@ -94,7 +90,6 @@ Using a theme is as simple as changing the `colorScheme` param in your `config.t
9490
colorScheme = "scheme-darkbrown"
9591
DateFormat = "2 Jan 2006"
9692
description = "A Hugo Theme built with Bootstrap"
97-
sidebarDescription = "A Hugo Theme built with Bootstrap"
9893
sidebarFreeText = "A optional paragraph of free text. Set to blank in config.toml to clear..."
9994

10095

@@ -150,7 +145,6 @@ Here is a full example `config.toml`:
150145
colorScheme = "scheme-darkbrown"
151146
DateFormat = "2 Jan 2006"
152147
description = "A blog about content"
153-
sidebarDescription = "This is my blog about content"
154148
sidebarFreeText = "A optional paragraph of free text. Set to blank in config.toml to clear..."
155149
piwikSiteID = ""
156150
piwikURL = ""

exampleSite/config.toml

+1-2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ theme = "strange-case"
1313
colorScheme = "scheme-darkbrown"
1414
dateformat = "Jan 2, 2006"
1515
description = "A Hugo Theme built with Bootstrap"
16-
sidebarDescription = "A Hugo Theme built with Bootstrap"
1716
sidebarFreeText = "A optional paragraph of free text. Set to blank in config.toml to clear..."
1817
piwikSiteID = ""
1918
piwikURL = ""
@@ -26,4 +25,4 @@ theme = "strange-case"
2625
[[menu.main]]
2726
name = "Bootstrap"
2827
post = "<span class='glyphicon glyphicon-ok'></span>"
29-
url = "http://getbootstrap.com"
28+
url = "http://getbootstrap.com"

layouts/partials/header.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8">
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
66
<meta name="viewport" content="width=device-width, initial-scale=1">
7-
{{ .Hugo.Generator }}
7+
{{ hugo.Generator }}
88
<!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
99
<title>{{ .Title }} - {{ .Site.Params.description }}</title>
1010

@@ -24,6 +24,6 @@
2424
{{ "<![endif]-->" | safeHTML }}
2525

2626
<!-- RSS -->
27-
<link href="{{ .RSSLink }}" rel="alternate" type="application/rss+xml" title="{{ .Site.Title }}" />
27+
<link href="{{ with .OutputFormats.Get "RSS" }}{{ .RelPermalink }}{{ end }}" rel="alternate" type="application/rss+xml" title="{{ .Site.Title }}" />
2828
</head>
29-
<body class="{{ .Site.Params.colorScheme }}">
29+
<body class="{{ .Site.Params.colorScheme }}">

0 commit comments

Comments
 (0)