提交 84247f10 编写于 作者: EvanOne(文一)'s avatar EvanOne(文一)

docs: Update README & CHANGELOG

Update & remove duplicate generated logs

Change Chinese document to main document
上级 213ca338
......@@ -4,108 +4,45 @@ All notable changes to this project will be documented in this file. See [standa
### 1.0.1 (2019-06-24)
### Bug Fixes
* Code highlight in index, about page & avatar auto center ([2276e50](https://github.com/liuyib/hexo-theme-stun/commit/2276e50))
* Display the reading progress bar only on the articles page ([cdaac3f](https://github.com/liuyib/hexo-theme-stun/commit/cdaac3f))
* Not show tag icon when empty & make header icon configable ([5c95bf5](https://github.com/liuyib/hexo-theme-stun/commit/5c95bf5))
* Post read progress line show minus ([6e7c7be](https://github.com/liuyib/hexo-theme-stun/commit/6e7c7be))
* Remove the display property of post to eliminate BFC effects ([b971e12](https://github.com/liuyib/hexo-theme-stun/commit/b971e12))
* Resolve read progress error, since post height equal zero ([cc1b6fa](https://github.com/liuyib/hexo-theme-stun/commit/cc1b6fa))
* Solve the problem of sidebar jumping ([6933c40](https://github.com/liuyib/hexo-theme-stun/commit/6933c40))
* Solve the problem that the menu always shows in mobile ([21cde8e](https://github.com/liuyib/hexo-theme-stun/commit/21cde8e))
* Solved the display of unordered list ([1ba789e](https://github.com/liuyib/hexo-theme-stun/commit/1ba789e))
* Solved the problem of layout confusion when the sidebar is left ([8c25692](https://github.com/liuyib/hexo-theme-stun/commit/8c25692))
* 标签数量显示错误问题 ([81e0d66](https://github.com/liuyib/hexo-theme-stun/commit/81e0d66))
### Features
* Add back to top button ([9248c62](https://github.com/liuyib/hexo-theme-stun/commit/9248c62))
* Add busuanzi count ([8930455](https://github.com/liuyib/hexo-theme-stun/commit/8930455))
* Add code highlight ([6f07572](https://github.com/liuyib/hexo-theme-stun/commit/6f07572))
* Add comment support ([60d928a](https://github.com/liuyib/hexo-theme-stun/commit/60d928a))
* Add config to automatically remain article excerpt ([94c6673](https://github.com/liuyib/hexo-theme-stun/commit/94c6673))
* Add custom top and bottom img & custom text in footer ([bac6900](https://github.com/liuyib/hexo-theme-stun/commit/bac6900))
* Add diff code highlight & scroll bar UI ([940028f](https://github.com/liuyib/hexo-theme-stun/commit/940028f))
* Add header nav responsive layout & do some mobile adaptation ([3187fe4](https://github.com/liuyib/hexo-theme-stun/commit/3187fe4))
* Add img align to config file & do some i18n ([880966c](https://github.com/liuyib/hexo-theme-stun/commit/880966c))
* Add post toc ([19bb1bc](https://github.com/liuyib/hexo-theme-stun/commit/19bb1bc))
* Add responsive layout ([a743b07](https://github.com/liuyib/hexo-theme-stun/commit/a743b07))
* Add reward & post tags & post copyright ([5cde659](https://github.com/liuyib/hexo-theme-stun/commit/5cde659))
* Add sidebar tab page & post read progress & i18n ([3b049e1](https://github.com/liuyib/hexo-theme-stun/commit/3b049e1))
* add sitebar of show site info ([b9101cc](https://github.com/liuyib/hexo-theme-stun/commit/b9101cc))
* Add tag, category page style ([2e4126a](https://github.com/liuyib/hexo-theme-stun/commit/2e4126a))
* Add the end hint at the end of post & make tags to config file ([b3605fb](https://github.com/liuyib/hexo-theme-stun/commit/b3605fb))
* Add the feature of stick post to the top ([fa9f25c](https://github.com/liuyib/hexo-theme-stun/commit/fa9f25c))
* Add the hyperlink to post title ([2d4089c](https://github.com/liuyib/hexo-theme-stun/commit/2d4089c))
* Add word count & reading time cout of post ([b0c34df](https://github.com/liuyib/hexo-theme-stun/commit/b0c34df))
* Auto switch toc tab when visit post page & error handling ([d8f3d99](https://github.com/liuyib/hexo-theme-stun/commit/d8f3d99))
* Click heading to stick top & refactor js code with jquery ([24ba46c](https://github.com/liuyib/hexo-theme-stun/commit/24ba46c))
* Provides a way to specify the size of the image ([aa4195f](https://github.com/liuyib/hexo-theme-stun/commit/aa4195f))
* Sidebar sticky top ([3561257](https://github.com/liuyib/hexo-theme-stun/commit/3561257))
* You can set whether the article list is paginated ([8f44318](https://github.com/liuyib/hexo-theme-stun/commit/8f44318))
* 修改主题底部、定义全局h标签样式 ([a7a554a](https://github.com/liuyib/hexo-theme-stun/commit/a7a554a))
* 全局标签的样式定义 ([8f4a573](https://github.com/liuyib/hexo-theme-stun/commit/8f4a573))
* 初步搭建项目结构,完成底部栏 ([5b17a37](https://github.com/liuyib/hexo-theme-stun/commit/5b17a37))
* 完成分类页面布局 ([74538a4](https://github.com/liuyib/hexo-theme-stun/commit/74538a4))
* 完成分页器样式 ([aa3dac4](https://github.com/liuyib/hexo-theme-stun/commit/aa3dac4))
* 完成底部栏 ([2f4424a](https://github.com/liuyib/hexo-theme-stun/commit/2f4424a))
* 完成归档页面 ([38d47ce](https://github.com/liuyib/hexo-theme-stun/commit/38d47ce))
* 完成文章页标题和辅助信息的样式 ([e516a35](https://github.com/liuyib/hexo-theme-stun/commit/e516a35))
* 完成有序列表样式 ([2fe08c7](https://github.com/liuyib/hexo-theme-stun/commit/2fe08c7))
* 完成标签页 ([bbcee95](https://github.com/liuyib/hexo-theme-stun/commit/bbcee95))
* 完成顶部栏 ([878627d](https://github.com/liuyib/hexo-theme-stun/commit/878627d))
* 网站信息后添加毛玻璃效果 ([d77aa9f](https://github.com/liuyib/hexo-theme-stun/commit/d77aa9f))
* 首页显示最近十篇文章 ([461bf46](https://github.com/liuyib/hexo-theme-stun/commit/461bf46))
### Bug Fixes
* Solved the problem of layout confusion when the sidebar is left ([8c25692](https://github.com/liuyib/hexo-theme-stun/commit/8c25692))
## [1.0.0](https://github.com/liuyib/hexo-theme-stun/compare/v1.0.0-beta.0...v1.0.0) (2019-06-23)
### Bug Fixes
* Display the reading progress bar only on the articles page ([cdaac3f](https://github.com/liuyib/hexo-theme-stun/commit/cdaac3f))
* Remove the display property of post to eliminate BFC effects ([b971e12](https://github.com/liuyib/hexo-theme-stun/commit/b971e12))
* Resolve read progress error, since post height equal zero ([cc1b6fa](https://github.com/liuyib/hexo-theme-stun/commit/cc1b6fa))
* Solve the problem of sidebar jumping ([6933c40](https://github.com/liuyib/hexo-theme-stun/commit/6933c40))
* Solve the problem that the menu always shows in mobile ([21cde8e](https://github.com/liuyib/hexo-theme-stun/commit/21cde8e))
* Solved the display of unordered list ([1ba789e](https://github.com/liuyib/hexo-theme-stun/commit/1ba789e))
### Features
* Add back to top button ([9248c62](https://github.com/liuyib/hexo-theme-stun/commit/9248c62))
* Add busuanzi count ([8930455](https://github.com/liuyib/hexo-theme-stun/commit/8930455))
* Add comment support ([60d928a](https://github.com/liuyib/hexo-theme-stun/commit/60d928a))
* Add config to automatically remain article excerpt ([94c6673](https://github.com/liuyib/hexo-theme-stun/commit/94c6673))
* Add custom top and bottom img & custom text in footer ([bac6900](https://github.com/liuyib/hexo-theme-stun/commit/bac6900))
* Add diff code highlight & scroll bar UI ([940028f](https://github.com/liuyib/hexo-theme-stun/commit/940028f))
* Add the end hint at the end of post & make tags to config file ([b3605fb](https://github.com/liuyib/hexo-theme-stun/commit/b3605fb))
* Add the feature of stick post to the top ([fa9f25c](https://github.com/liuyib/hexo-theme-stun/commit/fa9f25c))
* Add the hyperlink to post title ([2d4089c](https://github.com/liuyib/hexo-theme-stun/commit/2d4089c))
* Add word count & reading time cout of post ([b0c34df](https://github.com/liuyib/hexo-theme-stun/commit/b0c34df))
* Provides a way to specify the size of the image ([aa4195f](https://github.com/liuyib/hexo-theme-stun/commit/aa4195f))
## [1.0.0-alpha.0](https://github.com/liuyib/hexo-theme-stun/compare/v1.0.0-beta.0...v1.0.0-alpha.0) (2019-06-17)
## 1.0.0-beta.1 (2019-06-03)
### Bug Fixes
* Display the reading progress bar only on the articles page ([cdaac3f](https://github.com/liuyib/hexo-theme-stun/commit/cdaac3f))
* Remove the display property of post to eliminate BFC effects ([b971e12](https://github.com/liuyib/hexo-theme-stun/commit/b971e12))
* Resolve read progress error, since post height equal zero ([cc1b6fa](https://github.com/liuyib/hexo-theme-stun/commit/cc1b6fa))
* Display the reading progress bar only on the articles page ([cdaac3f](https://github.com/liuyib/hexo-theme-stun/commit/cdaac3f))
* Solve the problem of sidebar jumping ([6933c40](https://github.com/liuyib/hexo-theme-stun/commit/6933c40))
### Features
* Add back to top button ([9248c62](https://github.com/liuyib/hexo-theme-stun/commit/9248c62))
* Add busuanzi count ([8930455](https://github.com/liuyib/hexo-theme-stun/commit/8930455))
* Add comment support ([60d928a](https://github.com/liuyib/hexo-theme-stun/commit/60d928a))
* Add custom top and bottom img & custom text in footer ([bac6900](https://github.com/liuyib/hexo-theme-stun/commit/bac6900))
* Add diff code highlight & scroll bar UI ([940028f](https://github.com/liuyib/hexo-theme-stun/commit/940028f))
* Add the end hint at the end of post & make tags to config file ([b3605fb](https://github.com/liuyib/hexo-theme-stun/commit/b3605fb))
* Add the hyperlink to post title ([2d4089c](https://github.com/liuyib/hexo-theme-stun/commit/2d4089c))
* Add comment support ([60d928a](https://github.com/liuyib/hexo-theme-stun/commit/60d928a))
* Add busuanzi count ([8930455](https://github.com/liuyib/hexo-theme-stun/commit/8930455))
* Add word count & reading time cout of post ([b0c34df](https://github.com/liuyib/hexo-theme-stun/commit/b0c34df))
## 1.0.0-beta.0 (2019-06-03)
......@@ -115,7 +52,6 @@ All notable changes to this project will be documented in this file. See [standa
* Code highlight in index, about page & avatar auto center ([2276e50](https://github.com/liuyib/hexo-theme-stun/commit/2276e50))
* Not show tag icon when empty & make header icon configable ([5c95bf5](https://github.com/liuyib/hexo-theme-stun/commit/5c95bf5))
* Post read progress line show minus ([6e7c7be](https://github.com/liuyib/hexo-theme-stun/commit/6e7c7be))
...
### Features
......@@ -131,4 +67,3 @@ All notable changes to this project will be documented in this file. See [standa
* Auto switch toc tab when visit post page & error handling ([d8f3d99](https://github.com/liuyib/hexo-theme-stun/commit/d8f3d99))
* Click heading to stick top & refactor js code with jquery ([24ba46c](https://github.com/liuyib/hexo-theme-stun/commit/24ba46c))
* Sidebar sticky top ([3561257](https://github.com/liuyib/hexo-theme-stun/commit/3561257))
...
\ No newline at end of file
<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>
<h3 align="center">一个漂亮、简洁的 hexo 主题</h3>
<p align="center">
<a href="http://commitizen.github.io/cz-cli/" target="_blank" rel="noopener noreferrer">
......@@ -13,45 +13,47 @@
<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/liuyib/hexo-theme-stun.svg?style=flat-square">
<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)
[English](https://github.com/liuyib/hexo-theme-stun/blob/master/README_en_US.md) | [中文简体](https://github.com/liuyib/hexo-theme-stun/blob/master/README.md)
## Demo
> 一个新的 hexo 主题,希望多多支持。目前在全力开发 & 维护中,有问题可以 issue 或 email 我。
## 演示
- [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).
如果你正在使用 stun 主题,并希望像上面一样,在这里展示出来,你可以通过 [PR](https://github.com/liuyib/hexo-theme-stun/pulls) 将你的网站链接填写在这里。
## Installation
## 安装
- Install stun
- 安装 stun
Enter your hexo directory, run this.
进入 hexo 根目录,执行指令。
``` bash
git clone https://github.com/liuyib/hexo-theme-stun.git themes/stun
```
- Install pug and stylus
- 安装 pug 和 stylus
If you don't have pug and stylus renderer, run this (If you`re not sure, just do it).
如果你没有安装对 pug、stylus 的支持,执行指令(如果你不确定,直接执行指令就好了)。
``` bash
npm install --save-dev hexo-render-pug hexo-renderer-stylus
```
## How to use
## 使用
Modify the `_config.yml` file in your hexo root directory.
修改 hexo 根目录下的 `_config.yml` 文件。
``` yml
theme: stun
```
## Update
## 更新
``` bash
cd themes/stun
......@@ -59,14 +61,14 @@ cd themes/stun
git pull
```
## Configuration
## 配置
Please see: [https://liuyib.github.io/hexo-theme-stun/](https://liuyib.github.io/hexo-theme-stun/)
请查看:[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)
<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">一个漂亮、简洁的 hexo 主题</h3>
<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">
......@@ -13,45 +13,45 @@
<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">
<img alt="GitHub release" src="https://img.shields.io/github/release/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)
[English](https://github.com/liuyib/hexo-theme-stun/blob/master/README_en_US.md) | [中文简体](https://github.com/liuyib/hexo-theme-stun/blob/master/README.md)
## 演示
## Demo
- [liuyib`s Blog](https://liuyib.github.io/)
如果你正在使用 stun 主题,并希望像上面一样,在这里展示出来,你可以通过 [PR](https://github.com/liuyib/hexo-theme-stun/pulls) 将你的网站链接填写在这里。
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
- 安装 stun
- Install stun
进入 hexo 根目录,执行指令。
Enter your hexo directory, run this.
``` bash
git clone https://github.com/liuyib/hexo-theme-stun.git themes/stun
```
- 安装 pug 和 stylus
- Install pug and stylus
如果你没有安装对 pug、stylus 的支持,执行指令(如果你不确定,直接执行指令就好了)。
If you don't have pug and stylus renderer, run this (If you`re not sure, just do it).
``` bash
npm install --save-dev hexo-render-pug hexo-renderer-stylus
```
## 使用
## How to use
修改 hexo 根目录下的 `_config.yml` 文件。
Modify the `_config.yml` file in your hexo root directory.
``` yml
theme: stun
```
## 更新
## Update
``` bash
cd themes/stun
......@@ -59,14 +59,14 @@ cd themes/stun
git pull
```
## 配置
## Configuration
请查看:[https://liuyib.github.io/hexo-theme-stun/](https://liuyib.github.io/hexo-theme-stun/)
Please see: [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)
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册