README.md

<p align="center"><a href="https://liuyib.github.io/hexo-theme-stun/" target="_blank" rel="noopener noreferrer"><img width="100" src="https://raw.githubusercontent.com/liuyib/picBed/master/hexo-blog/20190603093757.png" alt="stun logo"></a></p>

<h3 align="center">A beautiful & simple theme for Hexo</h3>

<p align="center">
  <a href="http://commitizen.github.io/cz-cli/" target="_blank" rel="noopener noreferrer">
    <img alt="Commitizen friendly" src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square">
  </a>
  <a href="https://github.com/liuyib/hexo-theme-stun/blob/master/LICENSE" target="_blank" rel="noopener noreferrer">
    <img alt="GitHub" src="https://img.shields.io/github/license/liuyib/hexo-theme-stun.svg?style=flat-square">
  </a>
  <a href="https://hexo.io/zh-cn/" target="_blank" rel="noopener noreferrer">
    <img alt="hexo" src="https://img.shields.io/badge/hexo-%3E%3D3.0-blue.svg?style=flat-square">
  </a>
  <a href="https://github.com/liuyib/hexo-theme-stun/releases" target="_blank" rel="noopener noreferrer">
    <img alt="GitHub release" src="https://img.shields.io/github/release-pre/liuyib/hexo-theme-stun.svg?style=flat-square">
  </a>
</p>

[English](https://github.com/liuyib/hexo-theme-stun/blob/master/README.md) | [中文简体](https://github.com/liuyib/hexo-theme-stun/blob/master/README_zh_CN.md)

## Demo

- [liuyib`s Blog](https://liuyib.github.io/)

If you are using the stun theme and would like it to be shown here, you can fill in your website link by [PR](https://github.com/liuyib/hexo-theme-stun/pulls).

## Installation

- Install stun

Enter your hexo directory, run this.

``` bash
git clone https://github.com/liuyib/hexo-theme-stun.git themes/stun
```

- Install pug and stylus (optional)

If you don't have pug and stylus renderer, run this.

``` bash
npm install --save-dev hexo-render-pug hexo-renderer-stylus
```

## How to use

Modify the `_config.yml` file in your hexo root directory.

``` yml
theme: stun
```

## Update

``` bash
cd themes/stun

git pull
```

## Configuration

If you don't want to bother, you only need o fill the image path of the wetbsite favicon and your avatar to complete the most basic configuration. Other configuration items are default.

``` yml
favicon: # url or path

avatar: # url or path
```

Detailed configuration, please visit: [https://liuyib.github.io/hexo-theme-stun/](https://liuyib.github.io/hexo-theme-stun/)

## Browser Support

IE >= 10

## License

[MIT](https://github.com/liuyib/hexo-theme-stun/blob/master/LICENSE)