From 90726f1a5907c9877a171d79c41c0422aea66d59 Mon Sep 17 00:00:00 2001 From: Jerry Date: Thu, 21 Nov 2019 22:08:02 +0800 Subject: [PATCH] update README --- README.md | 31 +++++++++++++++++++------------ README.zn.md => README_CN.md | 24 ++++++++++++++---------- 2 files changed, 33 insertions(+), 22 deletions(-) rename README.zn.md => README_CN.md (67%) diff --git a/README.md b/README.md index aadbf2d..0a73fa8 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,13 @@ Hexo node.js +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) \ No newline at end of file diff --git a/README.zn.md b/README_CN.md similarity index 67% rename from README.zn.md rename to README_CN.md index c10c7f3..e3e4b7e 100644 --- a/README.zn.md +++ b/README_CN.md @@ -5,14 +5,16 @@ Hexo node.js +Demo: https://demo.jerryc.me/ -[预览](https://jerryc.me/) +JerryC: https://jerryc.me/ -一款基于[hexo-theme-melody](https://github.com/Molunerfinn/hexo-theme-melody)修改的主题 -## 安装 +一款基於[hexo-theme-melody](https://github.com/Molunerfinn/hexo-theme-melody)修改的主題 -在你的博客根目录里 +## 安裝 + +在你的博客根目錄裏 ``` git clone -b master https://github.com/jerryc127/hexo-theme-butterfly.git themes/Butterfly @@ -24,19 +26,21 @@ git clone -b master https://github.com/jerryc127/hexo-theme-butterfly.git themes git clone -b dev https://github.com/jerryc127/hexo-theme-butterfly.git themes/Butterfly ``` -## 应用主题 -修改hexo配置文件`_config.yml`，把主题改为`Butterfly` +## 應用主題 +修改hexo配置文件`_config.yml`，把主題改為`Butterfly` ``` theme: Butterfly ``` ->如果你没有pug以及stylus的渲染器，请下载安装： npm install hexo-renderer-pug hexo-renderer-stylus --save or yarn add hexo-renderer-pug hexo-renderer-stylus +>如果你沒有pug以及stylus的渲染器，請下載安裝： npm install hexo-renderer-pug hexo-renderer-stylus --save or yarn add hexo-renderer-pug hexo-renderer-stylus -## 文档 +## 文檔 -可查看[这里](https://jerryc.me/posts/21cfbf15) +可查看[這裏](https://jerryc.me/posts/21cfbf15) -## 截图 +## 截圖 ![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/69338594-7d03f980-0c9e-11ea-8b64-7f165e6508e2.png) \ No newline at end of file