Tranquilpeak

This repo is modified from the original Tranquilpeak theme.

A gorgeous responsive theme for Hugo blog framework.

Summary

General
Features
Quick start
Demo
Documentation
Contributing
Showcase
License

General

Original Authors: Thibaud Leprêtre (kakawait) and Louis Barranqueiro (LouisBarranqueiro)
Modified by: Sijie Hu (Superjie13)
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 (kakawait/hugo-tranquilpeak-theme#8)
Pagination customization tagPagination, categoryPagination and archivePagination (kakawait/hugo-tranquilpeak-theme#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/Superjie13/hugo-tranquilpeak.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)

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://tranquilpeak.kakawait.com/2015/06/who-is-using-tranquilpeak-hugo-theme/

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

License

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

superjie13 / hugo-tranquilpeak Goto Github PK

hugo-tranquilpeak's Introduction