Solitude Docs

English

简体中文

English

简体中文

Appearance

Installation ​

Setting up Hexo ​

If you don't have a Hexo blog yet, please refer to the Hexo official documentation for installation and site creation.

Author's Note ​

Please read the documentation carefully. The usage of the theme can be found in the documentation. Do not waste others' time.

Please note that the configuration in _config.solitude.yml takes precedence over the theme's _config.yml. So, after updating the theme, compare the content of the theme/solitude/_config.yml file with the original configuration file. Usually, the release notes will provide specific instructions or a diff of the configuration file versions. Make the necessary changes to the original configuration file accordingly.

This guide does not cover all configuration explanations, but almost every configuration has comments in the theme configuration. You can refer to both the guide and the comments for usage reference.

In addition, this guide only includes instructions within the scope of the theme. If it involves the usage of Hexo or Hexo plugins, please refer to their respective documentation.

If you find any bugs in the theme or want to add new features, please leave a message in the issues. For usage-related questions, please ask in the Discussions.

Installation ​

bash
git clone -b main https://github.com/everfu/hexo-theme-solitude.git themes/solitude
bash
git clone -b dev https://github.com/everfu/hexo-theme-solitude.git themes/solitude
bash
git pull

Applying ​

Modify the root configuration file _config.yml of Hexo and change the theme to solitude.

yaml
theme: solitude

Dependencies ​

The theme uses Pug and Stylus and requires installing their respective renderers.

shell
npm install hexo-renderer-pug hexo-renderer-stylus --save
# or
pnpm add hexo-renderer-pug hexo-renderer-stylus

Language ​

Modify the site configuration file _config.yml (not the theme configuration file).

Supported languages: en-US (American English), zh-CN (Simplified Chinese), zh-TW (Traditional Chinese)

yaml
language: en-US # Language

Start ​

shell
hexo server

Usage Note

If you encounter display caching issues, you can try hexo clean to clear the cache and start again.

Optimization ​

Run the following command in the blog's root directory to copy the theme's configuration file to the root directory for better theme configuration.

bash
cp -rf ./themes/solitude/_config.yml ./_config.solitude.yml
bash
copy .\themes\solitude\_config.yml .\_config.solitude.yml

Tip

  • The configuration in the root directory's _config.solitude.yml takes precedence. Therefore, the content of this file's configuration items will be used during rendering.
  • When updating the theme, there may be configuration changes. Please pay attention to the update instructions, as you may need to manually modify _config.solitude.yml.
  • To check if the overridden configuration has taken effect, you can use hexo generate --debug to view the command line output.

Version Number Explanation ​

The version number of this project is in the format X.Y.Z, but it has some differences from the common Semantic Versioning Specification. The specific explanations are as follows:

  • X: Redesign at the product level, including major framework refactoring, significant functional changes, and configuration changes. Please read the relevant documentation before updating.

  • Y: Contains medium to large new features and non-backward compatible functional changes and configuration changes. Updating this version may require modifying configurations or removing some original features.

  • Z: Includes bug fixes, small new features, and backward-compatible updates to original features and configuration changes. In principle, updating this version does not require any additional actions.