Merge pull request #100 from kakawait/develop

Releasing 0.2.1-ALPHA

Author: kakawait

.github/CONTRIBUTING.md

@@ -0,0 +1,31 @@
+# Contributing #
+
+All kinds of contributions (enhancements, new features, documentation & code improvements, issues & bugs reporting) are welcome.
+
+## Code style ##
+
+### Javascript
+
+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 ##
+
+When you create an issue to report a bug or ask a question, please fill template information, except if is **really not relevant**. And all others related information that are susceptible to help us.
+
+## Pull requests ##
+
+All pull requests must be done on the **develop** branch.
+
+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
+ 

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,18 @@
+<!-- use this template only to report a bug or ask a question -->
+<!-- fill this part for bugs reporting or questions -->
+### Configuration
+
+ - **Operating system with its version**: 
+ - **Browser with its version**:
+ - **Hugo version**: <!-- You can get version by typing: hugo version -->
+ - **Tranquilpeak version**: <!-- You can find version on package.json -->
+ - **Do you reproduce on https://tranquilpeak.kakawait.com demo?**:
+ 
+<!-- fill this part for bugs reporting if needed  -->
+### Actual behavior
+
+<!-- fill this part for bugs reporting if needed  -->
+### Expected behavior
+
+<!-- fill this part for bugs reporting if needed -->
+### Steps to reproduce the behavior

CHANGELOG.md

@@ -2,6 +2,49 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.2.1-ALPHA](https://github.com/kakawait/hugo-tranquilpeak-theme/milestone/10) - 8 jan 2017
+
+- Easy customization of head and foot via `/layouts/partials/(head|foot)_(start|end).html` ([#80](https://github.com/kakawait/hugo-tranquilpeak-theme/pull/80)) (thank you [@blaubaer](https://github.com/blaubaer))
+- New front matters to hide/show pagination, social buttons and tags ([#81](https://github.com/kakawait/hugo-tranquilpeak-theme/pull/81)) (thank you [@blaubaer](https://github.com/blaubaer))
+- Sidebar author avatar link modifiable ([#81](https://github.com/kakawait/hugo-tranquilpeak-theme/pull/81)) (thank you [@blaubaer](https://github.com/blaubaer))
+
+```toml
+[params.sidebar.profile]
+    url = ...
+```
+
+- Alert shortcode support markdown content ([#91](https://github.com/kakawait/hugo-tranquilpeak-theme/issues/91))
+
+```
+{{< alert info >}}
+Praesent diam elit, **interdum** ut [pulvinar](http://foo.bar) placerat, imperdiet at magna.
+{{< /alert >}}
+```
+
+- Add basic post archetype ([#76](https://github.com/kakawait/hugo-tranquilpeak-theme/issues/76))
+- Remove `en.yaml` symlink ([#84](https://github.com/kakawait/hugo-tranquilpeak-theme/issues/84))
+- Fix gravatar integration that was broken ([#87](https://github.com/kakawait/hugo-tranquilpeak-theme/issues/87))
+- Fix missing css for post meta ([#89](https://github.com/kakawait/hugo-tranquilpeak-theme/issues/89))
+- Fix front matters `coverSize` ([#93](https://github.com/kakawait/hugo-tranquilpeak-theme/issues/93))
+
+### Breaking changes
+
+Related to [#84](https://github.com/kakawait/hugo-tranquilpeak-theme/issues/84), language code `en` does not exist anymore.
+
+Replace if relevant
+
+```toml
+languageCode = "en"
+defaultContentLanguage = "en"
+```
+
+to
+
+```toml
+languageCode = "en-us"
+defaultContentLanguage = "en-us"
+```
+
 ## [0.2.0-ALPHA](https://github.com/kakawait/hugo-tranquilpeak-theme/milestone/2) - 4 dec 2016
 
 - *De-bundlize* every external scripts/css ([#66](https://github.com/kakawait/hugo-tranquilpeak-theme/pull/66)) for many reasons:

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.2.0-ALPHA (based on Hexo version 1.9.1)
+- **Version**: 0.2.1-ALPHA (based on Hexo version 1.9.1)
 - **Compatibility**: Hugo v0.17
 
 ## Features
@@ -141,6 +141,8 @@ To understand the code, the workflow and edit the theme, consult the following d
 
 All kinds of contributions (enhancements, new features, documentation & code improvements, issues & bugs reporting) are welcome.
 
+Read [guidelines for contributing](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/.github/CONTRIBUTING.md) for more information.
+
 As explained on [Credits](#credits):
 
 > *Hugo* version keeps every `.js` and `.css` files untouched from original *Hexo* version in order to enjoy futur original *Hexo* version updates or features! 

archetypes/post.md

@@ -0,0 +1,15 @@
+---
+title: "New Post"
+date: 2015-05-28
+categories:
+- category
+- subcategory
+tags:
+- tag1
+- tag2
+keywords:
+- tech
+#thumbnailImage: //example.com/image.jpg
+---
+
+<!-- more /-->

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.2.0-ALPHA (based on Hexo version 1.9.1)
+- **Version** : 0.2.1-ALPHA (based on Hexo version 1.9.1)
 - **Compatibility** : Hugo v0.17
 
 ## Requirements ##

docs/user.md

@@ -52,7 +52,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.2.0-ALPHA (based on Hexo version 1.9.1)
+- **Version**: 0.2.1-ALPHA (based on Hexo version 1.9.1)
 - **Compatibility**: Hugo v0.17
 
 ## Features
@@ -144,7 +144,7 @@ If your language is not available, follow this guidelines (E.g : add swedish lan
 
 1. Set `defaultContentLanguage` to `sv-se` in Hugo configuration file `config.{toml,yaml,json}`  
 2. Create `sv-se.yaml` file in `theme/tranquilpeak/i18n/` folder  
-3. Copy the content of `theme/tranquilpeak/i18n/en.yaml` and paste it to `sv-se.yml` file  
+3. Copy the content of `theme/tranquilpeak/i18n/en-us.yaml` and paste it to `sv-se.yml` file  
 4. Replace all strings in english by their translation in swedish    
 
 #### Menu translation
@@ -479,6 +479,9 @@ gallery:
     - http://i.imgur.com/o9r19kD.jpg "Dubai"
     - https://example.com/orignal.jpg https://example.com/thumbnail.jpg "Sidney"
 comments: false
+showTags: true
+showPagination: true
+showSocial: true
 ```
 
 |Variable|Description|
@@ -496,6 +499,9 @@ comments: false
 |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.
+|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`
 
 Example: 
 A post on index page will look like this with :`thumbnailImagePosition` set to `bottom`:  

exampleSite/config.toml

@@ -1,5 +1,5 @@
 # Tranquilpeak
-# Version : 0.2.0-ALPHA
+# Version : 0.2.1-ALPHA
 # Author : Thibaud Leprêtre
 
 # I STRONGLY recommend you to use a CDN to speed up loading of pages.
@@ -14,13 +14,13 @@
 
 baseurl = ""
 languageCode = "en-us"
+defaultContentLanguage = "en-us"
 title = "Hugo tranquilpeak theme"
 theme = "hugo-tranquilpeak-theme"
 disqusShortname = "hugo-tranquilpeak-theme"
 # googleAnalytics = "UA-123-45"
 paginate = 7
 canonifyurls = true
-defaultContentLanguage = "en-us"
 
 [permalinks]
   post = "/:year/:month/:slug/"
@@ -165,6 +165,10 @@ defaultContentLanguage = "en-us"
     icon = ""
     url = "/#about"
 
+  # Customize like of athor avatar in sidebar
+  # [params.sidebar.profile]
+  #   url = "/#about"
+
   # Customize copyright value "© 2016 <CUSTOMIZATION>. All Rights Reserved"
   # [params.footer]
-  #   copyright = "<a href=\"https://github.com/kakawait\">kakawait</a>"
+  #   copyright = "<a href=\"https://github.com/kakawait\">kakawait</a>"

exampleSite/content/post/Hidden-pagination-showcase.md

@@ -0,0 +1,17 @@
+---
+title: "Hidden pagination showcase"
+thumbnailImagePosition: left
+thumbnailImage: //d1u9biwaxjngwg.cloudfront.net/cover-image-showcase/city-750.jpg
+date: 2014-08-15
+categories:
+- tranquilpeak
+- features
+tags:
+- pagination
+showPagination: false
+---
+
+This post is used to show how a site looks if the pagination is hidden.
+<!--more-->
+
+In enim justo, rhoncus ut, imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium. Integer tincidunt. Cras dapibus. Vivamus elementum semper nisi. Aenean vulputate eleifend tellus. Aenean leo ligula, porttitor eu, consequat vitae, eleifend ac, enim. Aliquam lorem ante, dapibus in, viverra quis, feugiat a, tellus.

exampleSite/content/post/Hidden-social-section-showcase.md

@@ -0,0 +1,17 @@
+---
+title: "Hidden social section showcase"
+thumbnailImagePosition: left
+thumbnailImage: //d1u9biwaxjngwg.cloudfront.net/cover-image-showcase/city-750.jpg
+date: 2014-08-17
+categories:
+- tranquilpeak
+- features
+tags:
+- social
+showSocial: false
+---
+
+This post is used to show how a site looks if the social section is hidden.
+<!--more-->
+
+In enim justo, rhoncus ut, imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium. Integer tincidunt. Cras dapibus. Vivamus elementum semper nisi. Aenean vulputate eleifend tellus. Aenean leo ligula, porttitor eu, consequat vitae, eleifend ac, enim. Aliquam lorem ante, dapibus in, viverra quis, feugiat a, tellus.