kakawait/hugo-tranquilpeak-theme

A gorgeous responsive theme for Hugo blog framework

Tranquilpeak

A gorgeous responsive theme for Hugo blog framework.

Alpha/Beta versions

ATTENTION during alpha or beta versions breaking changes are possible on config file.

You can track breaking changes label.

How can I migrate my current version? Please read CHANGELOG.md.

Summary

• General
• Features
• Quick start
• Demo
• Documentation
• Contributing
• Showcase
• License

General

• Authors: Thibaud Leprêtre (kakawait) and Louis Barranqueiro (LouisBarranqueiro)
• Version: 0.5.3-BETA (based on Hexo version 3.1.0)
• Compatibility: Hugo v0.53

Features

General features:

• Fully responsive
• Optimized for tablets & mobiles
• Configurable menu of the sidebar
• Pages to filter tags, categories and archives
• Background cover image
• Beautiful about page
• Support Open Graph protocol
• Easily customizable (fonts, colors, layout elements, code coloration, etc..)
• Support internationalization (i18)

Posts features:

• Thumbnail image
• Cover image
• Responsive videos & images
• Sharing options
• Navigation menu
• GitHub theme for code highlighting (customizable)
• Image gallery
• Tags for images (FancyBox), wide images, tabbed code blocks, highlighted text, alerts
• Table of contents

Integrated services:

• Disqus
• Gitlak
• Google analytics
• Gravatar
• Facebook Insights

Missing features from original Hexo version

• Algolia (#8)
• Pagination customization tagPagination, categoryPagination and archivePagination (#17)

ATTENTION following features will not be possible due to Hugo limitations

• Archives pages by years /archives/2015
• Archives pages by month /archives/2015/01

Quick start

Please read user documentation, it's short and useful to discover all features and possibilities of the theme, especially the writing posts section

For people who want to use the original version of Tranquilpeak without modifications (users)

Go to the directory where you have your Hugo site and run:

mkdir themes
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 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. It will be useful to learn how to customize your site. Feel free to play around with the settings.

More information on user documentation to install and configure the theme

For people who want to create their own version of tranquilpeak (developers)

1. Run git clone https://github.com/kakawait/hugo-tranquilpeak-theme.git
2. Follow developer documentation to edit and build the theme

Demo

Check out Tranquilpeak theme in live : hugo-tranquilpeak-theme demo

Showcase

Checkout showcase https://tranquilpeak.kakawait.com/2015/06/who-is-using-tranquilpeak-hugo-theme/

How can I add my site to the showcase

Click here to add your blog into the showcase.

Please fill the following information:

1. public url
2. name (optional)
3. description (optional)

Documentation

If it's your first time using Hugo, please check Hugo official documentation

For users

To install and configure the theme, consult the following documentation : user documentation

For developers

To understand the code, the workflow and edit the theme, consult the following documentation : developer documentation

Contributing

All kinds of contributions (enhancements, features, documentation & code improvements, bugs reporting) are welcome.

Read guidelines for contributing for more information.

Credits

Hugo version of Tranquilpeak is a based on original Hexo version https://github.com/LouisBarranqueiro/hexo-theme-tranquilpeak. This version is simply a port to Hugo static site generator.

License

hugo-tranquilpeak-theme is released under the terms of the GNU General Public License v3.0.

hugo-tranquilpeak-theme's Issues

Jump to TOC does not really work

Back port dev documentation from original theme

archive page return 404

https://tranquilpeak.kakawait.com/archives

Missing title when using caption

Expected

Actual

Allow links on Copyrights

see #32 (comment)

Page opens at the end of the page with Firefox

When I open the blog with Firefox, the page is not opened at the top.

Algolia support

sidebar showing posts

My sidebar menu is showing my posts (I currently only have 2), any idea what is going on here? I'd just like to show the menu items with no posts. I have the default sidebar menu configuration.

Switch overall language - multilingual blog

I would like to have a solution to switch via menu-item between different languages (e.g. english to german).

All terms (e.g. sidebar menu, i18n Strings ) should be translated.

https://gohugo.io/content/multilingual/

Rewrite theme.toml

Change version from "Welcome to tranquilpeak 1.9.0" post

Remove hexo blog post from tranquilpeak.kakawait.com

Add a search bar

A search bar is useful to search article in blog.

Back port user documentation from original theme

GitHub actions to deploy https://tranquilpeak.kakawait.com based on exampleSite

event widget or site

• show events on a separate site or as a sidebar widget
• datasource should be an caldav server

Add archetype

Idea comes from @Martin1001 on commit:

1393e23

Need to report it on next release

Failed to load translations in file "en.yaml"

I tried to build a site with this theme and was given the following error:

$ hugo -d ../libmb.github.io/ -t hugo-tranquilpeak-theme -D
Started building sites ...
Error: Error building site: Failed to load translations in file "en.yaml": failed to load en.yaml because yaml: unmarshal errors:
  line 1: cannot unmarshal !!str `en-us.yaml` into []map[string]interface {}

I noticed that the en.yaml file did not contain valid yaml but looked like it was linking to the en-us.yaml file. I copied the contents of en-us.yaml to en.yaml and I was able to build my site.

Add my blog into the showcase

Hey, add my blog into the showcase:

https://alain.deleglise.net

Fix tags link at end of article

Fix chinese and japanese filename

it should be 日本語テスト.md and 中文測試.md

related to #33

Add prism.js support

Hi,

Is it possible to use another code block type ?

The one currently used isn't very "sexy".

Clean/Upgrade npm package

 async                  ^1.5.2  →   ^2.1.2
 jsdom                  ^8.1.0  →   ^9.8.3
 jquery                 ^2.2.4  →   ^3.1.1
 strip-indent           ^1.0.1  →   ^2.0.0
 eslint                ^2.11.1  →  ^3.10.2
 eslint-config-google   ^0.5.0  →   ^0.7.0
 grunt                  ^0.4.5  →   ^1.0.1
 grunt-bower           ^0.18.0  →  ^0.21.3
 grunt-contrib-clean    ~0.5.0  →   ~1.0.0
 grunt-contrib-concat   ^0.5.0  →   ^1.0.1
 grunt-contrib-copy     ~0.4.1  →   ~1.0.0
 grunt-contrib-cssmin  ^0.12.0  →   ^1.0.2
 grunt-contrib-uglify   ^0.7.0  →   ^2.0.0
 grunt-contrib-watch    ^0.6.1  →   ^1.0.0
 grunt-exec             ^0.4.6  →   ^1.0.1
 grunt-sails-linker    ^0.10.1  →   ^1.0.4
 grunt-sass              1.1.0  →    1.2.1
 grunt-sync             ^0.2.3  →   ^0.6.2
 include-all            ^0.1.6  →   ^2.0.0
 load-grunt-tasks       ~0.2.0  →   ~3.5.2

The following dependencies are satisfied by their declared version range, but the installed versions are behind. You can install the latest versions without modifying your package file by using npm update. If you want to update the dependencies in your package file anyway, use ncu -a/--upgradeAll.

 marked   ^0.3.5  →   ^0.3.6
 moment  ^2.13.0  →  ^2.16.0
 bower   ^1.3.12  →   ^1.8.0

Run ncu with -u to upgrade package.json

• eslint from 2.11.1 to 3.10.2 fix new eslint errors https://gist.github.com/kakawait/60213c3954566abdcf600c4686ab058c

How to set custom font in this theme?

Theming 404 pages

Can be related to LouisBarranqueiro/hexo-theme-tranquilpeak#327

Publish on http://themes.gohugo.io/

Create release.sh script

• deploy sample site https://tranquilpeak.kakawait.com
• push static on CDN
• update version on every files
• add git tag with new version

Add my blog into the showcase

Hey, add my blog into the showcase:
https://www.DesktopLuxury.com
Author - Inderdeep Singh Bajwa

i18n support

Help are welcome if you want to add translation that is not already part of original theme https://github.com/LouisBarranqueiro/hexo-theme-tranquilpeak/tree/master/languages

Disqus issue on demo site

Layout for static pages (no blog post)

• remove date
• remove navigation buttons
• adjust social bar

number of month is shown instead of day

I configure my preferred dateFormat in my config file and getting wrong output. I have change it from "1 January 2006" to "2 January 2006" and it works. It would be great if you could add an example into the docs. General Output without setting dateFormat is correct.

**config param **
dateFormat = "1 January 2006"

date of post
date: 2016-11-15

date in generate
11 November 2016

Main cover used as post cover.

Hi,

When using the coverImage inside the definition of a post, the post cover is indeed displayed on the post but the blog cover is also displayed.

Missing README.md

I think you are missing a readme file.

Uniformise config key

between snake_case, camelCase and other

Support tag_pagination, category_pagination and archive_pagination

Migrate to built in hugo SEO template

https://github.com/spf13/hugo/blob/142558719324aa1628541d556ef1fa2d123f1e68/tpl/tplimpl/template_embedded.go#L159

Migration scripts are not cross compiled

Migrate google analytics

Related to LouisBarranqueiro/hexo-theme-tranquilpeak#361 ga.js is deprecated.

I also want to use Hugo common key configuration googleAnalytics (https://gohugo.io/extras/analytics/) instead of custom one Params.google_analytics_id

That will break changes, user must migrate from

[params]
  google_analytics_id = ...

to

googleAnalytics = ...

Moreover I will delete google-analytics.html in favor of built-in internal template (async) one.

Update FontAwesome

This is partially a question and partially a request. How can I update the FontAwesome version? I wanted to use an icon that is not present in the version included.
It would of course be nice if the most up-to-date version is automatically included.

Table is not correctly generated

Generate gh-pages

global config key thumbnailImagePosition is not used

[params]
    thumbnailImagePosition = "bottom"

is never used

Generate highlight at build time

fix lint error

/Volumes/diskE/Users/t5e/Projects/blog/hugo-tranquilpeak-theme/tasks/config/sails-linker.js
   9:26  error  Unexpected space before function parentheses  space-before-function-paren
  23:26  error  Unexpected space before function parentheses  space-before-function-paren
  37:26  error  Unexpected space before function parentheses  space-before-function-paren
  51:26  error  Unexpected space before function parentheses  space-before-function-paren

Disqus console error on blog post list

Create exampleSite

Remove search from demo until Algolia support

js URL of google analytics is invalid

correct code is like this:

(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-1234-1', 'auto');
ga('send', 'pageview');

but actual code is like this:

(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-1234-1', 'auto');
ga('send', 'pageview');

there was missing https in URL https://www.google-analytics.com/analytics.js

Remove swiftype references