tjwudi / tranquilpeak-hexo-theme-fork

Fork of tranquilpeak-hexo-theme

Tranquilpeak Hexo theme

A gorgeous responsive theme for Hexo blog framework

Summary

• General
• Features
• Quick start
• Demo
• Showcase
• Documentation
  • For users
  • For developers
• Contributing
• License

General

• Author : Louis Barranqueiro
• Version : 1.3.0
• Compatibility : Hexo 3.0.0 or later

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
• Support internationalization (i18n)

Posts features :

• Thumbnail image
• Cover image
• Responsive videos & images
• Sharing options
• Navigation menu
• GitHub theme for code highlighting
• Image gallery
• Image generator helpers
• Table of contents

Integrated services :

• Disqus
• Google analytics
• Gravatar
• Swiftype
• Facebook Insights

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 (users)

1. Download the latest version ready for production utilisation here : [tranquilpeak-hexo-theme-built-for-production-1.3.0] (https://github.com/LouisBarranqueiro/tranquilpeak-hexo-theme/releases/download/v1.3.0/tranquilpeak-hexo-theme-built-for-production-1.3.0.zip) or choose an other version here : all releases
2. Follow 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/LouisBarranqueiro/tranquilpeak-hexo-theme.git
2. Follow developer documentation to edit and build the theme

Demo

Check out Tranquilpeak theme in live : Tranquilpeak-hexo-theme demo

Showcase

I would like to create a showcase with all blogs having a customized version of tranquilpeak theme. If you have customized the original version, please, add your blog into.

Via an issue

1. Create an issue with your blog url and a short description of your changes by clicking here

Via a pull request

1. Fork the project
2. On the master branch, add your blog URL, a short description of your changes and your github name into SHOWCASE.md file
3. Respect the format : [url_of_your_blog](url_of_your_blog) - short_description_of_your_changes - [github_name](url_of_your_github_page)
4. Create a pull request on the master branch

I will judge if the theme is enough customized to be added into showcase.

Documentation

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

For users

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

For developers

To understand better the code 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.

All pull requests must be done on the dev branch.

License

Tranquilpeak-hexo-theme is released under the terms of the GNU General Public License v3.0