Skip to main content

Installation

Prerequisites

Node.js (>=16), Git, Hexo, and a working Hexo blog. If you're new to these, start with the Hexo docs.

Steps

1. Clone the theme

Clone this repository into your Hexo blog's themes/tranquility folder:

cd hexo
git clone https://github.com/zycwer/hexo-theme-tranquility.git themes/tranquility

2. Enable the theme

Set the theme field to tranquility in your blog's root _config.yml (see Themes | Hexo).

3. Install dependencies

Remove conflicting dependencies and install the required ones:

npm uninstall hexo-generator-category hexo-generator-archive
npm install hexo-pagination moment opentype.js

4. Theme configuration

Copy themes/tranquility/_config-template.yml to your blog's root directory and rename it to _config.tranquility.yml. Personalize the theme by editing _config.tranquility.yml. See the Configuration section or read the comments in the config file.

Troubleshooting (for non-developers)

Reading error messages helps locate issues quickly. For example:

Missing dependencies

As the theme evolves, it may depend on more third-party modules. Users need to add new dependencies themselves. For example:

...
Error: Cannot find module 'a_third_module'
...

The message clearly indicates the a_third_module module is missing — just install it:

npm install a_third_module

See npm-install | npm Docs.