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.

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

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.

Please all the credit should be attributed to original Hexo version and its author Louis Barranqueiro.

Hugo version keeps every .js and .css files untouched from original Hexo version in order to enjoy futur original Hexo version updates or features!

General

Authors: Louis Barranqueiro (LouisBarranqueiro) and Thibaud Leprêtre (kakawait)
Version: 0.4.3-BETA (based on Hexo version 1.10.0)
Compatibility: Hugo v0.20.1

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
Google analytics
Gravatar
Facebook Insights

Missing features from original Hexo version

Baidu analytics
Algolia (kakawait#8)
Pagination customization tagPagination, categoryPagination and archivePagination (kakawait#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 Universal 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)

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

Demo

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

Showcase

Checkout showcase https://github.com/kakawait/hugo-tranquilpeak-theme/wiki/Showcase

How can I add my site to the showcase

Click here to add your blog into the showcase.

Please fill the following information:

public url
name (optional)
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, new features, documentation & code improvements, issues & bugs reporting) are welcome.

Read guidelines for contributing for more information.

As explained on Credits: