Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/devcows/hugo-universal-theme.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdrián Moreno <adrian@morenomartinez.com>2017-05-26 16:13:04 +0300
committerGuillermo Guerrero Ibarra <wolf.fox1985@gmail.com>2017-05-26 16:13:04 +0300
commitf79fe7db3a22d644c691e4947df7d073287a00fc (patch)
treedbe1c58bcb1edb81ac684e382181433b4698f09d /README.md
parent27412573e83a5f11807932c5d46dc3f4af468a38 (diff)
Add top bar with social links from official theme (#74)
* Add top bar with social links from official theme This adds the official top bar typically used to include contact information and social links. - Ability to enable/disable the top bar (disabled by default) - Ability to customize the text message - Ability to customize the social links and icons from config.toml - Compatible with older config.toml - Fixes #73 * Add top bar usage information in README file
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md
index 968230e..0927aae 100644
--- a/README.md
+++ b/README.md
@@ -22,6 +22,7 @@ This Hugo theme was ported from [Bootstrapious](http://bootstrapious.com/p/unive
* [Menu](#menu)
* [Sidebar widgets](#sidebar-widgets)
* [Blog post thumbnails](#blog-post-thumbnails)
+ * [Top bar](#top-bar)
* [Landing page](#landing-page)
* [Carousel](#carousel)
* [Features](#features)
@@ -174,6 +175,34 @@ You can enable/disable them under `params.widgets`.
tags = true
```
+### Top bar
+
+The top bar is typically used to provide contact information and social links. It is disabled by default, and it can be enabled inside the `params.topbar` settings.
+
+```toml
+[params.topbar]
+ enable = true
+ text = "<p>Contact us on +420 777 555 333 or hello@universal.com.</p>"
+```
+
+The `text` shows up on the left side and accepts HTML.
+
+The social links on the right side are configured as a top-level menu.
+
+```toml
+[[menu.topbar]]
+ weight = 1
+ name = "GitHub"
+ url = "https://github.com/devcows/hugo-universal-theme"
+ pre = "<i class='fa fa-2x fa-github'></i>"
+
+[[menu.topbar]]
+ weight = 2
+ name = "Facebook"
+ url = "http://facebook.com"
+ pre = "<i class='fa fa-2x fa-facebook'></i>"
+```
+
### Blog post thumbnails
After creating a new post you can define a banner by entering the relative path to the image.