update README

This commit is contained in:
Jerry
2019-11-21 22:08:02 +08:00
parent ae73a2114f
commit 90726f1a59
2 changed files with 33 additions and 22 deletions

View File

@@ -5,10 +5,13 @@
<a href="https://hexo.io"><img alt="Hexo" src="https://img.shields.io/badge/hexo-3.0+-0e83c"/></a>
<a href="https://nodejs.org/"><img alt="node.js" src="https://img.shields.io/badge/node.js-6.0-blur"/></a>
Demo: https://demo.jerryc.me/
[Blog / Demo](https://jerryc.me/)
JerryC: https://jerryc.me/
Inspirecd by [hexo-theme-melody](https://github.com/Molunerfinn/hexo-theme-melody) theme.
Based on [hexo-theme-melody](https://github.com/Molunerfinn/hexo-theme-melody) theme.
## Installation
@@ -18,26 +21,30 @@ Stable branch:
git clone -b master https://github.com/jerryc127/hexo-theme-butterfly.git themes/Butterfly
```
Bleeding edge unstable branch:
Dev branch:
```
git clone -b dev https://github.com/jerryc127/hexo-theme-butterfly.git themes/Butterfly
```
## Activate
Modify hexo config `_config.yml` and chaneg to `Butterfly` theme.
## Configuration
```
theme: Butterfly
```
Set theme in the hexo work folder's root config file `_config.yml`:
You need to install some dependencies: pug, stylus npm install hexo-renderer-pug hexo-renderer-stylus --save or yarn add hexo-renderer-pug hexo-renderer-stylus
> theme: Butterfly
## More information
If you don't have pug & stylus renderer, try this:
[More information](https://jerryc.me/posts/21cfbf15)
> npm install hexo-renderer-pug hexo-renderer-stylus
## Documentation
Documentation is [here](https://jerryc.me/posts/21cfbf15). it supports `zh-TW`
## Screenshots
![image](https://user-images.githubusercontent.com/16351105/58887365-1272f780-8718-11e9-9329-3292c6ba20d4.png)
![image](https://user-images.githubusercontent.com/16351105/58887457-3cc4b500-8718-11e9-9417-2bdea603c92e.png)
![](https://user-images.githubusercontent.com/16351105/58887457-3cc4b500-8718-11e9-9417-2bdea603c92e.png)
![](https://user-images.githubusercontent.com/16351105/69338594-7d03f980-0c9e-11ea-8b64-7f165e6508e2.png)