You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Revamp _open sidebar_ behavior to not push the content out of container ([#278](https://github.com/kakawait/hugo-tranquilpeak-theme/issues/278)) (thank you [johnsoncodehk](https://github.com/johnsoncodehk))
8
+
- Fix category name when using special char ([#269](https://github.com/kakawait/hugo-tranquilpeak-theme/issues/269))
9
+
- Fix param `async` & `defer` from `customJS` ([#289](https://github.com/kakawait/hugo-tranquilpeak-theme/pull/289))
10
+
- Add support of `mailto:` in menu link ([#208](https://github.com/kakawait/hugo-tranquilpeak-theme/issues/208))
11
+
- Add support of `MathJax` ([#294](https://github.com/kakawait/hugo-tranquilpeak-theme/pull/294))
12
+
- And more see milestone page for complete log
13
+
5
14
## [0.4.3-BETA](https://github.com/kakawait/hugo-tranquilpeak-theme/milestone/18) - 12 nov 2017
6
15
7
16
- Typo fix from `highligth.js` to correct on `highlight.js` ([#231](https://github.com/kakawait/hugo-tranquilpeak-theme/pull/231)) (thank you [@zacbook](https://github.com/zacbook))
Copy file name to clipboardExpand all lines: README.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ How can I migrate my current version? Please read [CHANGELOG.md](https://github.
20
20
21
21
Please all the credit should be attributed to [original *Hexo* version](https://github.com/LouisBarranqueiro/hexo-theme-tranquilpeak) and its author [Louis Barranqueiro](https://github.com/LouisBarranqueiro).
22
22
23
-
*Hugo* version keeps every `.js` and `.css` files untouched from original *Hexo* version in order to enjoy futur original *Hexo* version updates or features!
23
+
*Hugo* version keeps every `.js` and `.css` files untouched from original *Hexo* version in order to enjoy future original *Hexo* version updates or features!
24
24
25
25
## Summary
26
26
@@ -36,12 +36,12 @@ Please all the credit should be attributed to [original *Hexo* version](https://
36
36
## General
37
37
38
38
-**Authors**: [Louis Barranqueiro (LouisBarranqueiro)](https://github.com/LouisBarranqueiro) and [Thibaud Leprêtre (kakawait)](https://github.com/kakawait)
39
-
-**Version**: 0.4.3-BETA (based on Hexo version 1.10.0)
39
+
-**Version**: 0.4.4-BETA (based on Hexo version 1.10.0)
40
40
-**Compatibility**: Hugo v0.20.1
41
41
42
42
## Features
43
43
44
-
**General features:**
44
+
**General features:**
45
45
46
46
- Fully responsive
47
47
- Optimized for tablets & mobiles
@@ -52,8 +52,8 @@ Please all the credit should be attributed to [original *Hexo* version](https://
@@ -101,23 +101,23 @@ After installing the Tranquilpeak theme successfully, we recommend you to take a
101
101
102
102
First, let's take a look at the [config.toml](exampleSite/config.toml). It will be useful to learn how to customize your site. Feel free to play around with the settings.
103
103
104
-
More information on [user documentation](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/user.md) to install and configure the theme
104
+
More information on [user documentation](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/user.md) to install and configure the theme
105
105
106
-
### For people who want to create their own version of tranquilpeak (developers)
106
+
### For people who want to create their own version of tranquilpeak (developers)
107
107
108
-
1. Run `git clone https://github.com/kakawait/hugo-tranquilpeak-theme.git`
109
-
2. Follow [developer documentation](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/developer.md) to edit and build the theme
108
+
1. Run `git clone https://github.com/kakawait/hugo-tranquilpeak-theme.git`
109
+
2. Follow [developer documentation](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/developer.md) to edit and build the theme
110
110
111
111
## Demo
112
112
113
113
Check out Tranquilpeak theme in live : [hugo-tranquilpeak-theme demo](https://tranquilpeak.kakawait.com)
**Click [here](https://github.com/kakawait/hugo-tranquilpeak-theme/issues/new?title=Add%20my%20blog%20into%20the%20showcase&body=Hey,%20add%20my%20blog%20into%20the%20showcase:) to add your blog into the showcase.**
122
122
123
123
Please fill the following information:
@@ -130,9 +130,9 @@ Please fill the following information:
130
130
131
131
If it's your first time using Hugo, please check [Hugo official documentation](https://gohugo.io/overview/introduction/)
132
132
133
-
### For users
133
+
### For users
134
134
135
-
To install and configure the theme, consult the following documentation : [user documentation](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/user.md)
135
+
To install and configure the theme, consult the following documentation : [user documentation](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/user.md)
136
136
137
137
### For developers
138
138
@@ -146,7 +146,7 @@ Read [guidelines for contributing](https://github.com/kakawait/hugo-tranquilpeak
146
146
147
147
As explained on [Credits](#credits):
148
148
149
-
> *Hugo* version keeps every `.js` and `.css` files untouched from original *Hexo* version in order to enjoy futur original *Hexo* version updates or features!
149
+
> *Hugo* version keeps every `.js` and `.css` files untouched from original *Hexo* version in order to enjoy future original *Hexo* version updates or features!
150
150
151
151
That mean I would keep a strong dependency with original *Hexo* theme. Thus if you want to suggest any modifications on `.css` or `.js` files **I will submit those changes to original *Hexo* theme** (except if it's really specific to *Hugo* bugs that is not present on *Hexo*).
| sidebarBehavior | Define the behavior of the header and sidebar :<ul><li>1: Display extra large sidebar on extra large screen, large sidebar on large screen, medium sidebar on medium screen and header bar on small screen and extra large sidebar is swiped on extra large screen and large sidebar on all lower screens when open button is clicked (default)</li><li>2: Display large sidebar on extra large & large screen, medium sidebar on medium screen and header bar on small screen and large sidebar is swiped when open button is clicked</li><li>3: Display medium sidebar on large and medium screen and header bar on small screen and medium sidebar is swiped when open button is clicked</li><li>4: Display header bar on all screens, extra large sidebar is swiped on extra large screen and large sidebar is swiped on all lower screens</li><li>5: Display header bar on all screens and large sidebar is swiped on large screen</li><li>6: isplay header bar on all screens and medium sidebar is swiped</li></ul> |
356
+
| sidebarBehavior | Define the behavior of the header and sidebar :<ul><li>1: Display extra large sidebar on extra large screen, large sidebar on large screen, medium sidebar on medium screen and header bar on small screen and extra large sidebar is swiped on extra large screen and large sidebar on all lower screens when open button is clicked (default)</li><li>2: Display large sidebar on extra large & large screen, medium sidebar on medium screen and header bar on small screen and large sidebar is swiped when open button is clicked</li><li>3: Display medium sidebar on large and medium screen and header bar on small screen and medium sidebar is swiped when open button is clicked</li><li>4: Display header bar on all screens, extra large sidebar is swiped on extra large screen and large sidebar is swiped on all lower screens</li><li>5: Display header bar on all screens and large sidebar is swiped on large screen</li><li>6: Display header bar on all screens and medium sidebar is swiped</li></ul> |
356
357
| clearReading | Hide sidebar on all article page to let article take full width to improve reading, and enjoy wide images and cover images. Useless if `sidebarBehavior` is equal to `3` or `4`. (true: enable, false: disable). Default behavior : `params.clearReading` value in theme configuration file. |
357
358
| thumbnailImage | Display thumbnail image of each post on index pages |
358
359
| thumbnailImagePosition | Display thumbnail image at the right of title in index pages (`right`, `left` or `bottom`). Set this value to `right` if you have old posts to keep the old style on them and define `thumbnailImagePosition` on a post to overwrite this setting. (Default: `right`) |
@@ -495,6 +496,16 @@ Follow these steps, to add new filter :
You can configure how links to your site will appear in Twitter and/or Facebook. There are several ways of setting up card parameters:
502
+
503
+
***Title**: if in a page with title (like a post) it will use post title, otherwise, will use site title.
504
+
***Description**: will use article summary, if it does not exist, will use site description.
505
+
***Site author** (twitter only): will use the value of `twitter` field on ``[[params.Author]]`` section of your `config.toml` file.
506
+
***Content author** (twitter only): will use the value of the field `twitter` in your document header. If not specified, will use the **Site author** field value.
507
+
***Image**: will use the following fields in order, if one is not available, the next will be taken: thumbnail of document, cover of document, gallery images, gravatar email then author picture, .
508
+
498
509
## Quick & easy modifications
499
510
500
511
### Prerequisites
@@ -530,7 +541,8 @@ Please note, there are many different versions of Markdown and some of them are
530
541
Tranquilpeak introduces new variables to give you a lot of possibilities.
531
542
532
543
Example :
533
-
```markdown
544
+
545
+
```markdown
534
546
disqusIdentifier: fdsF34ff34
535
547
keywords:
536
548
- javascript
@@ -555,6 +567,7 @@ showTags: true
555
567
showPagination: true
556
568
showSocial: true
557
569
showDate: true
570
+
summary: "This is a custom summary and does *not* appear in the post."
558
571
```
559
572
560
573
|Variable|Description|
@@ -578,6 +591,7 @@ showDate: true
578
591
|showSocial|`true`: show social button such as share on Twitter, Facebook...|
579
592
|showMeta|`true`: Show post meta (date, categories).|
580
593
|showActions|`true`: Show post actions (navigation, share links).|
594
+
|summary|Custom excerpt text to show on the homepage.|
581
595
582
596
Example:
583
597
A post on index page will look like this with :`thumbnailImagePosition` set to `bottom`:
@@ -594,6 +608,7 @@ The same with : `thumbnailImagePosition` set to `left`:
594
608
Use:
595
609
596
610
-`<!--more-->` to define post excerpt and keep the post excerpt in the post content
611
+
- For a custom exerpt *not* in the post content, use the `summary` front-matter variable. Markdown syntax is supported.
Here you can find a list of the blogs that use Tranquilpeak theme, with different styles and customizations.
13
+
14
+
<!--more-->
15
+
16
+
If you want to add your site to this showcase, click [here](https://github.com/kakawait/hugo-tranquilpeak-theme/issues/new?title=Add%20my%20blog%20into%20the%20showcase&body=Hey,%20add%20my%20blog%20into%20the%20showcase:) and fill the following information:
0 commit comments