diff options
| author | Hugo Aguirre <bul.ikana@gmail.com> | 2018-10-06 23:39:51 +0300 |
|---|---|---|
| committer | Hugo Aguirre <bul.ikana@gmail.com> | 2018-10-06 23:39:51 +0300 |
| commit | 8c0afa862c79f2903754ce66ad141f0d3f1f3e82 (patch) | |
| tree | 388d775e4b82b236095da598ec834213b3541075 | |
| parent | 2b1efe028d7fd84709418d4c07d740637da43046 (diff) | |
Improve documentation
| -rw-r--r-- | README.md | 44 | ||||
| -rw-r--r-- | exampleSite/config.toml | 6 |
2 files changed, 45 insertions, 5 deletions
@@ -6,9 +6,49 @@ A Hugo theme, ported from [Webjeda-cards](http://webjeda.com/cards) ## Features -Responsive theme built on bootstrap. Easily add disqus, google analytics, social links and a facebook like box. +Responsive theme built on bootstrap. Great for showcasing content with featured images. -### Configuration +Easily add disqus, google analytics, social links and a facebook like box. + +## Configuration Please see the sample [`config.toml`](https://github.com/bul-ikana/hugo-cards/blob/master/exampleSite/config.toml). +### Social links + +#### facebook +A link to your facebook profile or page. This will show in the footer. + +#### quora +A link to your quora profile. This will show in the footer. + +#### twitter +A link to your twitter profile. This will show in the footer. + +#### github +A link to your github profile. This will show in the footer. + +#### email +Your email address. This will show in the footer and will opes as a `mailto:`. + +### Facebook like box + +#### fbLikeBox +Wheter you want to show a facebook like box. Accepted values are `yes` or `no`. Leave empty for `no` + +#### fbAppId +The app id you obtained from facebook developers page. + +#### fbPageUrl +A link to the facebook page or profile that will be shown in the like box. + +#### fbPageTitle +The title of the like box. This text will be shown while the box is loading. + +### Tracking and comments + +#### analytics +The Google Analytics tracking ID + +#### disqus +The disqus_thread ID diff --git a/exampleSite/config.toml b/exampleSite/config.toml index 9e921e2..c8a9302 100644 --- a/exampleSite/config.toml +++ b/exampleSite/config.toml @@ -1,4 +1,4 @@ -baseURL = "https://hugo-cards-site.netlify.com/" +baseurl = "http://example.org/" languageCode = "en-us" title = "Hugo Cards" theme = "hugo-cards" @@ -10,8 +10,8 @@ paginate = 6 facebook = "" quora = "" - twitter = "http://twitter.com/bul-ikana" - github = "http://github.com/bul_ikana" + twitter = "http://twitter.com/bul_ikana" + github = "http://github.com/bul-ikana" email = "" fbLikeBox = "" |