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

github.com/brycematheson/allegiant.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorbrycematheson <brycematheson@gmail.com>2015-11-21 21:12:36 +0300
committerbrycematheson <brycematheson@gmail.com>2015-11-21 21:12:36 +0300
commitfb5410553fcfce7db7b64577c1ebf37014d73df8 (patch)
treef43f09d3b5f63bdbd10276f72c43ffe6f7930d09
parent3d6ad697308e71f5239af648e3dd2f1c59062af5 (diff)
Updated readme
-rw-r--r--README.md38
1 files changed, 14 insertions, 24 deletions
diff --git a/README.md b/README.md
index c4e9910..0a80e25 100644
--- a/README.md
+++ b/README.md
@@ -4,9 +4,8 @@
Allegiant is a simple and clean blog theme for [Hugo](http://gohugo.io/). Some of the more notable features are:
- Super simple/clean design
-- Client side source code highlighting
-- Social links (Twitter, Facebook, GitHub, LinkedIn, Instagram, etc.)
-- Support for tags
+- Client side source code highlighting (using Highlight.js)
+- Social links (Twitter, Facebook, GitHub, LinkedIn, etc)
- Analytics with Google Analytics
- Responsive
- Font Awesome icons
@@ -27,30 +26,21 @@ You may specify following options in `config.toml` of your site to make use of
this theme's features.
```toml
-baseurl = "Your site URL"
+baseurl = "yoursitehere.com"
languageCode = "en-us"
title = "Allegiant"
-copyright = "&copy; Allegiant." # Copyright notice. This will be displayed in the footer
+copyright = "&copy; Allegiant. All Rights Reserved." # Copyright notice. This will be displayed in the footer.
+canonifyurls = true
[params]
- # Social accounts. Links to these accounts are displayed in the header and footer.
- twitter = "Your Twitter username"
- github = "Your GitHub username"
- linkedin = "Your LinkedIn username"
- googleplus = "Your Google+ user id"
- facebook = "Your Facebook username"
- # stackoverflow = "Your Stackoverflow user id (number)"
- # keybase = "Your keybase.io username"
- # instagram = "Your Instagram username"
- # Disqus shortname
- disqus = "Your disqus shortname"
- # Google Analytics API key.
- #ga_api_key = "Your Google Analytics tracking id"
- author = "Bryce Matheson"
- avatar = "/path/to/avatar"
- contact = "Your contact link (ex. mailto:foo@example.com)"
- bio = "Your short bio"
- # Short subtitle/tagline. This is displayed in the header.
- subtitle = "Short subtitle/tagline of your blog"
+ ga_api_key = "Your Google Analytics tracking id" # Google Analytics API key.
+ avatar = "../../img/avatar.jpg" # Image should be square, and roughly 150px x 150px
+ bio = "Insert your bio here. You should write something really whitty and interesting that nobody is ever going to read or care about. But such is life. I really like the look of having a bio snippet on the blog, though. You may have to adjust some CSS styles depending on how long or short your bio is. I didn't make it super resillient."
+ github = "http://github.com/username"
+ twitter = "https://twitter.com/username"
+ linkedin = "https://www.linkedin.com/in/username"
+ footer_1 = "Some text here."
+ footer_2 = "Some different text here."
+ footer_3 = "Even more different text here."
```