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

github.com/kakawait/hugo-tranquilpeak-theme.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorThibaud LeprĂȘtre <thibaud.lepretre@gmail.com>2017-04-15 15:22:40 +0300
committerThibaud LeprĂȘtre <thibaud.lepretre@gmail.com>2017-09-10 12:38:14 +0300
commit7f15006b51f3862700814610fbf89ec6447d3b8f (patch)
tree2961e7533f5e8e592fc5aa85bc4ad8b97b3a38d4 /docs
parent59a3489c0df882d1d77cc4bc585e204e4a3eeebb (diff)
Upgrade theme base on hexo 1.10.0 version
- [x] Italian translation - [x] `showMeta` & `showActions` - [x] `rel="noopener"` - [x] _sharing options_ - [x] XLG side bar bug on Edge - [x] 'OLDER POSTS' Button Overlaps Sidebar - [x] Print media queries However I will not backport persian translation because I can't handle by myself the missing translation for that theme that is not exist on hexo one closes #132
Diffstat (limited to 'docs')
-rw-r--r--docs/user.md55
1 files changed, 46 insertions, 9 deletions
diff --git a/docs/user.md b/docs/user.md
index b423147..f34b9da 100644
--- a/docs/user.md
+++ b/docs/user.md
@@ -28,6 +28,7 @@ If you want to report a bug or ask a question, [create an issue](https://github.
* [Author](#author)
* [Customization](#customization)
* [Integrated services](#integrated-services)
+ * [Sharing options](#sharing-options)
* [Enable pages](#enable-pages)
- [Integrated services configuration](#integrated-services-configuration)
* [Google Analytics](#google-analytics)
@@ -426,7 +427,43 @@ googleAnalytics =
| fbAdminIds | Your Facebook user ids used to connect your blog with your facebook user accounts (Facebook Insights). Use array syntax. E.g : `[9830047, 1003342]`. Visit [Facebook docs](https://developers.facebook.com/docs/platforminsights/domains) for more information. |
| fbAppId | Your Facebook app id used to connect your blog with your facebook app account (Facebook Insights). E.g : `9841307`. Visit [Facebook docs](https://developers.facebook.com/docs/platforminsights/domains) for more information. |
-### Enable pages
+#### Sharing options
+
+``` toml
+[params]
+ [[params.sharingOptions]]
+ name = "Facebook"
+ icon = "fa-facebook-official"
+ url = "https://www.facebook.com/sharer/sharer.php?u=%s"
+
+ [[params.sharingOptions]]
+ name = "Twitter"
+ icon = "fa-twitter"
+ url = "https://twitter.com/intent/tweet?text=%s"
+
+ [[params.sharingOptions]]
+ name = "Google+"
+ icon = "fa-google-plus"
+ url = "https://plus.google.com/share?url=%s"
+```
+
+You can comment and uncomment to enable or disable sharing options. If your own sharing options, simply add new sharing options on your configuration. E.g with **foo_bar** social network:
+
+```toml
+[params]
+ [[params.sharingOptions]]
+ name = "Foo bar"
+ icon = "fa-foo-bar"
+ url = "https://www.foo-bar.com/sharer/sharer.php?u=%s"
+```
+
+|Variable|Description|
+|---|---|
+|name| Name of your sharing site.|
+|icon|Name of the fontawesome icon class (Go to [font-awesome icons](http://fontawesome.io/icons/) to find class name of icon)|
+|url|URL of the link. use %s to specify where to put the permalink.|
+
+#### Enable pages
Tranquilpeak provides you 2 pages to display all posts title and date by tags, by categories, by date and an about page. To enable one of this pages simply add following [taxonomies](https://gohugo.io/taxonomies/overview/):
@@ -532,11 +569,13 @@ showDate: true
|coverCaption|Add a caption under the cover image : [Cover caption demo](https://tranquilpeak.kakawait.com/2015/05/cover-image-showcase/)|
|coverMeta|`in`: display post meta (title, date and categories) on cover image, `out`: display meta (title, date and categories) under cover image as usual. Default behavior : `in`|
|gallery|Images displayed in an image gallery (with fancybox) at the end of the post. If thumbnail image is not configured and cover image too, the first photo is used as thumbnail image. format: `original url [thumbnail url] [caption]`, E.g : `https://example.com/original.jpg https://example.com/thumbnail.jpg "New York"`|
-|comments|Disable the comment of the post.
+|comments|`true`: Show the comment of the post.|
|showDate|`true`: Show the date when `true` (default)|
-|showTags|`true`: show tags of this page. Default behavior: `true`
-|showPagination|`true`: show pagination. Default behavior: `true`
-|showSocial|`true`: show social button such as share on Twitter, Facebook... Default behavior: `true`
+|showTags|`true`: show tags of this page.|
+|showPagination|`true`: show pagination.|
+|showSocial|`true`: show social button such as share on Twitter, Facebook...|
+|showMeta|`true`: Show post meta (date, categories).|
+|showActions|`true`: Show post actions (navigation, share links).|
Example:
A post on index page will look like this with :`thumbnailImagePosition` set to `bottom`:
@@ -726,10 +765,8 @@ tags:
keywords:
- tech
comments: false
-showDate: false
-showSocial: false
-showTags: false
-showPagination: false
+showMeta: false
+showActions: false
#thumbnailImage: //example.com/image.jpg
---