Skip to content

Latest commit

 

History

History
111 lines (71 loc) · 3.25 KB

start-en.md

File metadata and controls

111 lines (71 loc) · 3.25 KB
Raw
title version permalink id lang
Start
1.4.0
en/start
1
en

Before using "Material", please read the Hexo documentions and finish the installation and configurations of Hexo.

In this docs, we suppose you just succefully installed the Hexo, and already configure your new site.

In Hexo, there are usually two configuration files, both called _config.yml. The first one is in the site root directory; the other is in the theme directory. For convenience of description, in the following description, the former is referred to as the site config and the latter as the theme config.

Installing "Material"

Installation of an Hexo theme is quite simple. You simply need to put the theme directory inside the themes directory of your site and modify the theme config. There are three ways to install the Material theme: using Github or NPM.

Direct download

Download a stable release and extract the content inside the themes/material directory.

NPM

Go in the site root directory and use the following commands:

npm install hexo-material
cp -R node_modules/hexo-material/ themes/material

Enable "Material"

Once you have the themes/material folder, open the site config, find the theme field, and change its value to material.

The folder themes/material can be named differently if you wish. You simply have to adapt the theme field accordingly.

The _config.yml file does not exist in the theme, you need to manually duplicate the _config.template.yml file and rename it to _config.yml

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

Update "Material"

Direct download

Save your _config.yml file somewhere. Then download a new stable release and extract the content inside the themes/material directory. Finally reconcile the new version of the _config.yml with the one you saved.

The previous commands will put aside your custom config, pull the update reapply your modifications. Fix conflicts if needed.

NPM

NPM updates can be done in two ways:

NPM update

Save your _config.yml file somewhere. Then use:

npm update hexo-material
rm -R themes/material
cp -R node_modules/hexo-material/ themes/material

Finally reconcile the new version of the _config.yml with the one you saved.

npm-check

Npm-check is used to check NPM dependency package for updates or errors.

Install npm-check:

npm install -g npm-check

Save your _config.yml file somewhere. Then use:

npm-check hexo-material

Use the space bar to select the package to update and press enter.

Basic settings

Language

Edit the site config and set language to the language you want.

Available languages ​​are:

  • العَرَبِيَّة (ar)
  • Deutsch (de)
  • English (en)
  • Español (es)
  • Français (fr)
  • 日本語 (ja)
  • Malay (ms)
  • Portuguese (Brazil) (pt-BR)
  • 简体中文 (zh-CN)
  • 繁體中文 (zh-TW)

For example, to use Traditional Chinese, the configuration would be:

language: zh-TW