Merge pull request #225 from kakawait/develop

Release 0.4.2

Author: kakawait

CHANGELOG.md

@@ -2,6 +2,28 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.4.2-BETA](https://github.com/kakawait/hugo-tranquilpeak-theme/milestone/17) - TBD
+
+- Support [prism.js](http://prismjs.com/) syntax highlighter in addition to _highlight.js_ ([#24](https://github.com/kakawait/hugo-tranquilpeak-theme/issues/24))
+- Upgrade external JS dependencies
+  - Jquery 2.1.3 to 2.2.4 ([#214](https://github.com/kakawait/hugo-tranquilpeak-theme/pull/214))
+  - Fancybox 2.1.4 to 2.1.7 ([#215](https://github.com/kakawait/hugo-tranquilpeak-theme/pull/215))
+  - Highlight 9.8.0 to 9.12.0 ([#219](https://github.com/kakawait/hugo-tranquilpeak-theme/pull/219))
+- Fix issue where link to every posts is display inside archive ([#203](https://github.com/kakawait/hugo-tranquilpeak-theme/issues/203))
+- Fix issue on global property `thumbnailimageposition` which was ignored ([#179](https://github.com/kakawait/hugo-tranquilpeak-theme/issues/179))
+- Add global property to allow swapping pagination ([#202](https://github.com/kakawait/hugo-tranquilpeak-theme/pull/202))
+
+### Breaking changes
+
+Since new syntax highlighter prism.js, you have to configure which syntax highlighter you want to use between _highlight.js_ and _prism.js_. **However if you don't configure it, no syntax highligh will be apply** (where previously _highlight.js_ was forced by default).
+
+Please upgrade you're `config.toml` (you can checkout `exampleSite/config.toml` to see sample) to re-add _highlight.js_ as syntax highlighter (except if you don't need it):
+
+```toml
+[params]
+  syntaxHighlighter = "highligth.js"
+```
+
 ## [0.4.1-BETA](https://github.com/kakawait/hugo-tranquilpeak-theme/milestone/16) - 11 sep 2017
 
 - Fix _sharing options_ link generation bug, that break shares ([#196](https://github.com/kakawait/hugo-tranquilpeak-theme/pull/196))

README.md

@@ -34,7 +34,7 @@ Please all the credit should be attributed to [original *Hexo* version](https://
 ## General
 
 - **Authors**: [Louis Barranqueiro (LouisBarranqueiro)](https://github.com/LouisBarranqueiro) and [Thibaud Leprêtre (kakawait)](https://github.com/kakawait)
-- **Version**: 0.4.1-BETA (based on Hexo version 1.10.0)
+- **Version**: 0.4.2-BETA(based on Hexo version 1.10.0)
 - **Compatibility**: Hugo v0.20.1
 
 ## Features

docs/developer.md

@@ -28,7 +28,7 @@ If you want to report a bug or ask a question, [create an issue](https://github.
 ## General ##
 
 - **Author** : Thibaud Leprêtre
-- **Version** : 0.4.1-BETA (based on Hexo version 1.10.0)
+- **Version** : 0.4.2-BETA (based on Hexo version 1.10.0)
 - **Compatibility** : Hugo v0.20.1
 
 ## Requirements ##

docs/user.md

@@ -54,7 +54,7 @@ If you want to report a bug or ask a question, [create an issue](https://github.
 ## General
 
 - **Authors**: [Louis Barranqueiro (LouisBarranqueiro)](https://github.com/LouisBarranqueiro) and [Thibaud Leprêtre (kakawait)](https://github.com/kakawait)
-- **Version**: 0.4.1-BETA (based on Hexo version 1.10.0)
+- **Version**: 0.4.2-BETA (based on Hexo version 1.10.0)
 - **Compatibility**: Hugo v0.20.1
 
 ## Features
@@ -347,6 +347,7 @@ E.g to display a shortcut to open algolia search window :
   favicon = /favicon.png
   imageGallery = true
   hierarchicalCategories = true
+  syntaxHighlighter = 'highlight.js'
 ```
 
 | Variable | Description |
@@ -362,6 +363,7 @@ E.g to display a shortcut to open algolia search window :
 | hierarchicalCategories | Define categories will create hierarchy between parents: `categories = ["foo", "bar"]` will consider "bar" a sub-category of "foo". If false it will flat categories. |
 | customCSS (_DEPRECATED see [Add custom JS or CSS using configuration](#add-custom-js-or-css-using-configuration)_) | Define files with css that override or extend the theme css: `customCSS` = ["css/mystyles.css"]. |
 | customJS (_DEPRECATED see [Add custom JS or CSS using configuration](#add-custom-js-or-css-using-configuration)_) | Define files with js that override or extend the theme js: `customJS` = ["js/myscripts.js"]. |
+| syntaxHighlighter | Define which syntax highlighter you want to use (if not set syntax highlighting is disable) between `highlight.js` and `prism.js` |
 
 E.g :  
 A category page look like this with `hierarchicalCategories = true` :  
@@ -497,7 +499,7 @@ Follow these steps, to add new filter :
 
 ### Prerequisites
 
-Since you are going to edit the theme, you have to install all the necessary to build it after changes : [Installation](https://github.com/LouisBarranqueiro/hexo-theme-tranquilpeak/blob/master/docs/developer.md#installation)
+Since you are going to edit the theme, you have to install all the necessary to build it after changes : [Installation](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/developer.md#installation)
 
 **Run command in theme folder : `hexo-blog/themes/tranquilpeak`**
 
@@ -513,7 +515,7 @@ Of course, you can replace it with an other theme found on highlight.js reposito
 Follow these steps :
 
 1. Get your theme here : [Highlight.js theme](https://github.com/isagalaev/highlight.js/tree/master/src/styles) or create yours
-2. Follow guidelines in `source/scss/themes/hljs-custom.scss` file
+2. Follow guidelines in `src/scss/themes/hljs-custom.scss` file
 3. Build the theme with `npm run prod` or `grunt buildProd`. Learn more about Grunt tasks : [Grunt tasks](https://github.com/LouisBarranqueiro/hexo-theme-tranquilpeak/blob/master/docs/developer.md#grunt-tasks)
 
 ## Writing posts

exampleSite/config.toml

@@ -1,5 +1,5 @@
 # Tranquilpeak
-# Version : 0.4.1-BETA
+# Version : 0.4.2-BETA
 # Author : Thibaud Leprêtre
 
 # I STRONGLY recommend you to use a CDN to speed up loading of pages.
@@ -12,7 +12,7 @@
 # For developpers, if you modify this theme, put your images in `source/images` folder and
 # use grunt task `build` to synchronize assets
 
-baseurl = ""
+baseURL = "https://example.org/"
 languageCode = "en-us"
 defaultContentLanguage = "en-us"
 title = "Hugo tranquilpeak theme"
@@ -107,6 +107,10 @@ canonifyurls = true
   # Global keywords configuration. Following keywords will be add to every pages
   # keywords = ["development", "next-gen"]
 
+  # Syntax highlighter, possible choice between: "highligth.js" (recommanded) and "prism.js" (experimental)
+  # You can comment it to disable syntax highligthing
+  syntaxHighlighter = "highligth.js"
+
   # Hide sidebar on all article page to let article take full width to improve reading, and enjoy wide images and cover images. (true: enable, false: disable)
   clearReading = true
 
@@ -166,11 +170,17 @@ canonifyurls = true
 
   # Custom CSS. Put here your custom CSS files. They are loaded after the theme CSS;
   # they have to be referred from static root. Example
-  # customCSS = ["css/foo.css"]
+  # [[params.customCSS]]
+  #   href = "css/mystyle.css"
 
   # Custom JS. Put here your custom JS files. They are loaded after the theme JS;
   # they have to be referred from static root. Example
-  # customJS = ["js/foo.js"]
+  # [[params.customJS]]
+  #   src = "js/myscript.js"
+
+  # Display `Next` on left side of the pagination, and `Prev` on right side one.
+  # If you set this value to `true`, these positions swap.
+  # swapPaginator = true
 
   # Sharing options
   # Comment and uncomment to enable or disable sharing options
@@ -200,6 +210,6 @@ canonifyurls = true
   # [params.sidebar.profile]
   #   url = "/#about"
 
-  # Customize copyright value "© 2016 <CUSTOMIZATION>. All Rights Reserved"
+  # Customize copyright value "© 2017 <CUSTOMIZATION>. All Rights Reserved"
   # [params.footer]
   #   copyright = "<a href=\"https://github.com/kakawait\">kakawait</a>"

exampleSite/content/post/Welcome-to-the-new-Tranquilpeak.md

@@ -1,5 +1,5 @@
 ---
-title: "Welcome to Tranquilpeak 0.4.1-BETA"
+title: "Welcome to Tranquilpeak 0.4.2-BETA"
 date: 2015-06-15
 categories:
 - tranquilpeak
@@ -65,7 +65,7 @@ Please all the credit should be attributed to [original *Hexo* version](https://
 ## General
 
 - **Authors**: [Louis Barranqueiro (LouisBarranqueiro)](https://github.com/LouisBarranqueiro) and [Thibaud Leprêtre (kakawait)](https://github.com/kakawait)
-- **Version**: 0.4.1-BETA (based on Hexo version 1.10.0)
+- **Version**: 0.4.2-BETA (based on Hexo version 1.10.0)
 - **Compatibility**: Hugo v0.20.1
 
 ## Features

i18n/ja.yaml

@@ -24,7 +24,7 @@
   translation: "プロフィール"
 
 - id: "global.author_picture"
-  translation: "著者の絵"
+  translation: "プロフィール画像"
 
 - id: "global.share_on"
   translation: "%sで共有"
@@ -113,45 +113,54 @@
   translation: "ウェブサイトへ"
 
 - id: "post.comment_and_share"
-  translation: "コメント・シェア"
+  translation: "コメント・共有"
 
 ## FOOTER ##
 - id: "footer.all_rights_reserved"
   translation: "All Rights Reserved"
 
 ## DATE ##
+- id: "date.year.suffix"
+  translation: "年"
+
+- id: "date.month.suffix"
+  translation: "月"
+
+- id: "date.day.suffix"
+  translation: "日"
+
 - id: "date.month.january"
-  translation: "一月"
+  translation: "1"
 
 - id: "date.month.february"
-  translation: "二月"
+  translation: "2"
 
 - id: "date.month.march"
-  translation: "三月"
+  translation: "3"
 
 - id: "date.month.april"
-  translation: "四月"
+  translation: "4"
 
 - id: "date.month.may"
-  translation: "五月"
+  translation: "5"
 
 - id: "date.month.june"
-  translation: "六月"
+  translation: "6"
 
 - id: "date.month.july"
-  translation: "七月"
+  translation: "7"
 
 - id: "date.month.august"
-  translation: "八月"
+  translation: "8"
 
 - id: "date.month.september"
-  translation: "九月"
+  translation: "9"
 
 - id: "date.month.october"
-  translation: "十月"
+  translation: "10"
 
 - id: "date.month.november"
-  translation: "十一月"
+  translation: "11"
 
 - id: "date.month.december"
-  translation: "十二月"
+  translation: "12"

i18n/vi.yaml

@@ -24,7 +24,7 @@
   translation: "Thông tin"
 
 - id: "global.author_picture"
-  translation: "Ảnh đại diện của tác giả"
+  translation: "Ảnh đại diện"
 
 - id: "global.share_on"
   translation: "Chia sẻ với %s"
@@ -104,54 +104,54 @@
   translation: "THẺ ĐÁNH DẤU"
 
 - id: "post.toc"
-  translation: "Phụ lục"
+  translation: "Mục lục"
 
 - id: "post.read_more"
   translation: "Đọc tiếp..."
 
 - id: "post.go_to_website"
-  translation: "Đi tới website"
+  translation: "Chuyển tới trang"
 
 - id: "post.comment_and_share"
-  translation: "Comment và chia sẻ"
+  translation: "Bình luận và chia sẻ"
 
 ## FOOTER ##
 - id: "footer.all_rights_reserved"
   translation: "All Rights Reserved"
 
 ## DATE ##
 - id: "date.month.january"
-  translation: "Tháng một"
+  translation: "tháng 1"
 
 - id: "date.month.february"
-  translation: "Tháng hai"
+  translation: "tháng 2"
 
 - id: "date.month.march"
-  translation: "Tháng ba"
+  translation: "tháng 3"
 
 - id: "date.month.april"
-  translation: "Tháng tư"
+  translation: "tháng 4"
 
 - id: "date.month.may"
-  translation: "Tháng năm"
+  translation: "tháng 5"
 
 - id: "date.month.june"
-  translation: "Tháng sáu"
+  translation: "tháng 6"
 
 - id: "date.month.july"
-  translation: "Tháng bảy"
+  translation: "tháng 7"
 
 - id: "date.month.august"
-  translation: "Tháng tám"
+  translation: "tháng 8"
 
 - id: "date.month.september"
-  translation: "Tháng chín"
+  translation: "tháng 9"
 
 - id: "date.month.october"
-  translation: "Tháng mười"
+  translation: "tháng 10"
 
 - id: "date.month.november"
-  translation: "Tháng mười một"
+  translation: "tháng 11"
 
 - id: "date.month.december"
-  translation: "Tháng mười hai"
+  translation: "tháng 12"

layouts/_default/summary.html

@@ -17,8 +17,8 @@
     {{ end }}
   {{ end }}
 {{ end }}
-{{ if and (.Scratch.Get "thumbnailImage") .Params.thumbnailimageposition }}
-  {{ .Scratch.Set "thumbnailImagePosition" .Params.thumbnailimageposition }}
+{{ if or .Params.thumbnailimageposition .Site.Params.thumbnailimageposition }}
+  {{ .Scratch.Set "thumbnailImagePosition" (.Params.thumbnailimageposition | default .Site.Params.thumbnailimageposition) }}
 {{ else }}
   {{ .Scratch.Set "thumbnailImagePosition" "bottom" }}
 {{ end }}

layouts/partials/archive-post.html

@@ -3,10 +3,10 @@ <h5 class="archive-result text-color-base text-xlarge" data-message-zero="{{ i18
   {{ range .GroupByDate "2006" }}
     {{ $year := .Key }}
     <div class="archive archive-year box" data-date="{{ $year }}">
-      <h4 class="archive-title" style="text-decoration: none;">{{ $year }}</h4>
+      <h4 class="archive-title" style="text-decoration: none;">{{ $year }}{{ if i18n "date.year.suffix" }}{{ i18n "date.year.suffix" }}{{ end }}</h4>
       {{ range .Pages.GroupByDate "01-January" }}
         <ul class="archive-posts archive-month" data-date="{{ $year }}{{ range first 1 (split .Key "-") }}{{ . }}{{ end }}">
-          <h5 class="archive-title" style="text-decoration: none;">{{ range last 1 (split .Key "-") }}{{ i18n (lower (printf "date.month.%s" .)) }}{{ end }}</h5>
+          <h5 class="archive-title" style="text-decoration: none;">{{ range last 1 (split .Key "-") }}{{ i18n (lower (printf "date.month.%s" .)) }}{{ if i18n "date.month.suffix" }}{{ i18n "date.month.suffix" }}{{ end }}{{ end }}</h5>
           {{ range .Pages }}
             <li class="archive-post archive-day" data-date="{{ dateFormat "20060102" .Date }}">
               <a class="archive-post-title" href="{{ .Permalink }}">{{ .Title }}</a>