5 Minutes Setup

Read the Docs & Introduction at Material Theme

阅读文档和介绍在 Material Theme

---

In Hexo, there are usually have two configuration files, one is in the site root directory _config.yml; the other is in the theme directory _config.yml. For convenience of description, in the following instructions, the former is referred to as a Site Profile, an latter is called a Theme Profile.

Install

Hexo installation of the theme is very simple, just put the theme file in the site directory themes directory, and then modify the configuration file. Specific to the Material, the installation steps are as follows.

Download the Material theme

You can select Clone or [Stable Release Version] (https://github.com/viosey/hexo-theme-material/releases).

In order to facilitate the subsequent update, we recommend the use of cloning. The cloning command is as follows:

$ cd your-hexo-site
$ git clone https://github.com/viosey/hexo-theme-material.git

Enable the Material theme

After the cloning is complete, modify the theme folder name, change it to 'material'.

Then open the Site Profile, find the theme field, and change its value to material.

Folder names can be freely modified, just make sure the theme field corresponds to it.

Run hexo s --debug and go to http://localhost: 4000 to make sure the site is running properly.

Theme settings

Language

Edit the Site Profile and set language to the language you want. Available languages are:

• English (en)
• Simplified Chinese (zh-CN)
• Traditional Chinese (zh-TW)
• Spanish (es)
• Japanese (ja)

For example: Select Traditional Chinese, the configuration is:

Language: en-US

### URL

Edit **site configuration file**, `url` fill in the main domain name, `root` fill in the subdirectory / root domain name

>For example: The domain name of the site is `http://example.com/hexo`:
>
>```Yml
url: http://example.com
root: / hexo

If your site is not running in a subdirectory, root is filled /.

Author name

Edit Site Profile, set author to your nickname.

Site Description Settings

Edit the Site Profile and set the 'description` field to your site description. The site description can be a signature you like :)