Merge pull request #355 from kakawait/develop

Release 0.4.5-BETA

Author: kakawait

.eslintrc

@@ -1,4 +1,7 @@
 {
+    "parserOptions": {
+        "ecmaVersion": 6
+    },
     "extends": "google",
     "rules": {
         "comma-dangle": [2,"never"],
@@ -10,6 +13,22 @@
         "no-trailing-spaces": [2, {"skipBlankLines": true }],
         "eqeqeq":[1],
         "max-len": [1, 100, 4, {"ignoreUrls": true}],
-        "no-useless-escape":0
+        "no-useless-escape":0,
+        "quote-props": [
+            2,
+            "as-needed"
+        ],
+        "no-var": "off",
+        "no-invalid-this": "off",
+        "indent": [
+            "error",
+            2,
+            {
+                "FunctionDeclaration": {
+                    "body": 1,
+                    "parameters": 2
+                }
+            }
+        ]
     }
-}
+}

.github/CONTRIBUTING.md

@@ -6,13 +6,11 @@ All kinds of contributions (enhancements, new features, documentation & code imp
 
 ### Javascript
 
-We use [ESLint](http://eslint.org) based on Google code style to maintain code style.  
+We use [ESLint](http://eslint.org) based on Google code style to maintain code style.
 Check code status with:
 
 ``` bash
 npm run lint
-# or
-grunt eslint
 ```
 
 ## Issues ##
@@ -28,4 +26,3 @@ Before a pull request :
  - There is no tests yet so verify that your code is running well. Blog generation (`hugo`) must not outputs errors
  - Check code style with eslint.
  - Don't forget to update user and/or developer documentation if it's necessary
- 

CHANGELOG.md

@@ -2,6 +2,32 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.4.5-BETA](https://github.com/kakawait/hugo-tranquilpeak-theme/milestone/20) - 03 jul 2019
+
+- Remove algolia search if site config is not enable ([#283](https://github.com/kakawait/hugo-tranquilpeak-theme/issues/283))
+- Site config `coverImage` is more consistent with other existing image config, refer to _breaking changes_ ([#327](https://github.com/kakawait/hugo-tranquilpeak-theme/issues/327))
+- `param` `coverImage` if relative now based on site base url ([#236](https://github.com/kakawait/hugo-tranquilpeak-theme/issues/236))
+- Fix `grunt` build to support newer `node` version ([#315](https://github.com/kakawait/hugo-tranquilpeak-theme/issues/315))
+- Fix `hugo` warnings/deprecations ([#340](https://github.com/kakawait/hugo-tranquilpeak-theme/pull/340) & [#349](https://github.com/kakawait/hugo-tranquilpeak-theme/pull/349))
+- Add swedish translation ([#345](https://github.com/kakawait/hugo-tranquilpeak-theme/pull/345)) (thank you [flojon](https://github.com/flojon))
+
+### Breaking changes
+
+Do not support anymore Hugo version <= 0.30!
+
+`coverImage` from `config.toml` now more consistent by do not fix default static folder to `images` (see [#327](https://github.com/kakawait/hugo-tranquilpeak-theme/issues/327) for more details).
+`coverImage` from `param` will now always based on base path and not relative to current url, thus
+
+```yml
+coverImage: img/a.jpg
+```
+
+will the be the same as
+
+```yml
+coverImage: /img/a.jpg
+```
+
 ## [0.4.4-BETA](https://github.com/kakawait/hugo-tranquilpeak-theme/milestone/19) - 09 sep 2018
 
 - 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))
@@ -23,7 +49,7 @@ Since I did an error on `highlight.js` for parameter `syntaxHighlighter`, sorry
 ```toml
 [params]
   syntaxHighlighter = "highlight.js"
-``` 
+```
 
 ## [0.4.2-BETA](https://github.com/kakawait/hugo-tranquilpeak-theme/milestone/17) - 1 nov 2017
 
@@ -107,7 +133,7 @@ With new _Sharing options_ that allow extensible list of sharing options, there
 
 ### Breaking changes
 
-Do not support anymore Hugo version < 0.20! 
+Do not support anymore Hugo version < 0.20!
 
 ## [0.2.3-ALPHA](https://github.com/kakawait/hugo-tranquilpeak-theme/milestone/12) - 31 mar 2017
 
@@ -200,7 +226,7 @@ defaultContentLanguage = "en-us"
     - `de-de` (thank you [@Martin1001](https://github.com/Martin1001))
 - Allow some customization on *copyright* section ([#48](https://github.com/kakawait/hugo-tranquilpeak-theme/issues/48))
 
-using 
+using
 
 ```toml
 [params.footer]
@@ -333,4 +359,4 @@ to (top level)
 
 ```toml
 googleAnalytics = "UA-XXX-X"
-```
+```

README.md

@@ -36,8 +36,8 @@ 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.4-BETA (based on Hexo version 1.10.0)
-- **Compatibility**: Hugo v0.20.1
+- **Version**: 0.4.5-BETA (based on Hexo version 1.10.0)
+- **Compatibility**: Hugo v0.30
 
 ## Features
 
@@ -97,7 +97,7 @@ cd themes
 git clone https://github.com/kakawait/hugo-tranquilpeak-theme.git
 ```
 
-After installing the Tranquilpeak theme successfully, we recommend you to take a look at the [exampleSite](exampleSite) directory. You will find a working Hugo site configured with the Universal theme that you can use as a starting point for your site.
+After installing the Tranquilpeak theme successfully, we recommend you to take a look at the [exampleSite](exampleSite) directory. You will find a working Hugo site configured with the Tranquilpeak theme that you can use as a starting point for your site.
 
 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.
 

docs/developer.md

@@ -1,6 +1,6 @@
 # Developer documentation #
 
-This documentation will help you to understand Tranquilpeak Hugo theme code.  
+This documentation will help you to understand Tranquilpeak Hugo theme code.
 
 If you want to report a bug or ask a question, [create an issue](https://github.com/kakawait/hugo-tranquilpeak-theme/issues/new).
 
@@ -28,8 +28,8 @@ If you want to report a bug or ask a question, [create an issue](https://github.
 ## General ##
 
 - **Author** : Thibaud Leprêtre
-- **Version** : 0.4.4-BETA (based on Hexo version 1.10.0)
-- **Compatibility** : Hugo v0.20.1
+- **Version** : 0.4.5-BETA (based on Hexo version 1.10.0)
+- **Compatibility** : Hugo v0.30
 
 ## Requirements ##
 
@@ -45,16 +45,14 @@ If you want to report a bug or ask a question, [create an issue](https://github.
 5. Install [requirements](#requirements)
 6. Run `npm install` to install [NPM dependencies](#npm-dependencies)
 
-If you want to configure the theme, please follow the [user documentation](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/user.md)  
+If you want to configure the theme, please follow the [user documentation](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/user.md)
 
 ## Code style ##
 
-We use [ESLint](http://eslint.org) based on Google code style to maintain javascript code style.  
+We use [ESLint](http://eslint.org) based on Google code style to maintain javascript code style.
 Check code style with :
 ``` bash
 npm run lint
-# or
-grunt eslint
 ```
 
 ## Code structure ##
@@ -76,7 +74,7 @@ tranquilpeak
 
 <!--### Languages ###
 
-Each files contains all labels used in the theme. 
+Each files contains all labels used in the theme.
 If you want to add a new language, duplicate an existing language file and replace all string by their translation.-->
 
 ### Views
@@ -99,10 +97,10 @@ If you want to add a new language, duplicate an existing language file and repla
 
 #### Stylesheets
 
-SCSS structure follow 7-1 pattern of [sass guidelines](http://sass-guidelin.es/#the-7-1-pattern)  
-If you want more information and to understand better this code, consult [sass guidelines](http://sass-guidelin.es/)  
+SCSS structure follow 7-1 pattern of [sass guidelines](http://sass-guidelin.es/#the-7-1-pattern)
+If you want more information and to understand better this code, consult [sass guidelines](http://sass-guidelin.es/)
 
-#### Images 
+#### Images
 
 ```
 ├── images
@@ -111,8 +109,8 @@ If you want more information and to understand better this code, consult [sass g
 |File|Description|
 |---|---|
 |cover.png|Default background cover of the blog|
-  
-Contains all images of the theme.  
+
+Contains all images of the theme.
 
 #### Javascript
 
@@ -148,13 +146,13 @@ Contains all images of the theme.
 |smartresize.js|Debouncing function from [John Hann](https://github.com/unscriptable)|
 |tabbed-codeblocks.js|Animate tabs of tabbed code blocks|
 |tags-filter.js|Filter posts by using their tags on archives page : `/tags`|
-  
-Each file correspond to a feature.  
-  
+
+Each file correspond to a feature.
+
 ## NPM scripts
 
-Use `npm run <script_name>` to run one of these scripts. E.g : `npm run start` 
-    
+Use `npm run <script_name>` to run one of these scripts. E.g : `npm run start`
+
 |`npm run ...`|Description|
 |---|---|
 |`start`|Build the theme once and rebuild after each change|
@@ -163,14 +161,14 @@ Use `npm run <script_name>` to run one of these scripts. E.g : `npm run start`
 
 ## Grunt tasks ##
 
-### Tasks structure 
-  
+### Tasks structure
+
 ```
 ├── tasks
     ├── config
     ├── register
     └── pipeline.js
-```  
+```
 
 |File/folder|Description|
 |---|---|
@@ -203,7 +201,7 @@ var tranquilpeakCssFilesToInject = [
 
 On production environment, these javascript and stylesheets files are concatenate and minify in 1 javascript file and 1 stylesheet file and linked to their respective views
 
-### Config tasks 
+### Config tasks
 
 |Task|Description|
 |---|---|
@@ -233,14 +231,14 @@ When you run `grunt build` or `grunt buildProd` tasks, a `source/assets` folder
 
 ## Build ##
 
-### Development environment  
+### Development environment
 
-1. Run `npm run start` or `grunt default` and start coding :)
+1. Run `npm run start` and start coding :)
 
 ### Production environment (before deploying your blog)
 
-1. Run `npm run prod` or `grunt buildProd` to build the project with some optimization (concat and minify) to reduce number of HTTP requests and improve performance.
+1. Run `npm run prod` to build the project with some optimization (concat and minify) to reduce number of HTTP requests and improve performance.
 
 ## Running ##
 
-Run `hugo server` and start coding! :)
+Run `hugo server` and start coding! :)