diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 20 |
1 files changed, 11 insertions, 9 deletions
@@ -38,29 +38,33 @@ 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 `<title>` 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: +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. - sidebarDescription = "A Hugo Theme built with Bootstrap" + sidebarFreeText = "A optional paragraph of free text. Set to blank in config.toml to clear..." -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. +You can include clickable icons (e.g. for social networks )by including `"menu=icons"` items in your `config.toml`. Example: - sidebarFreeText = "A optional paragraph of free text. Set to blank in config.toml to clear..." + [[menu.icons]] + name = "GitHub" + post = "<img src=\"/images/github.png\"" + url = "https://github.com" -You can also include useful menu links by including `"menu=main"` items in your `config.toml`. Example: +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. @@ -94,7 +98,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 +153,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 = "" |