README.md 5.6 KB
Newer Older
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
1 2
<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>

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
3
<h3 align="center">一个漂亮、简洁的 Hexo 主题</h3>
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
4 5

<p align="center">
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
6
  <a href="http://standardjs.com" target="_blank" rel="noopener noreferrer">
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
7
    <img alt="js-standard-style" src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg">
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
8
  </a>
9
  <a href="http://commitizen.github.io/cz-cli/" target="_blank" rel="noopener noreferrer">
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
10
    <img alt="Commitizen friendly" src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg">
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
11 12
  </a>
  <a href="https://github.com/liuyib/hexo-theme-stun/blob/master/LICENSE" target="_blank" rel="noopener noreferrer">
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
13
    <img alt="GitHub" src="https://img.shields.io/github/license/liuyib/hexo-theme-stun.svg">
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
14
  </a>
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
15
  <br>
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
16
  <a href="https://hexo.io/zh-cn/" target="_blank" rel="noopener noreferrer">
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
17
    <img alt="hexo" src="https://img.shields.io/badge/hexo-%3E%3D3.0-blue.svg">
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
18 19
  </a>
  <a href="https://github.com/liuyib/hexo-theme-stun/releases" target="_blank" rel="noopener noreferrer">
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
20
    <img alt="GitHub release" src="https://img.shields.io/github/release/liuyib/hexo-theme-stun.svg">
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
21
  </a>
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
22
  <a href="https://gitter.im/liuyib/hexo-theme-stun?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge" target="_blank" rel="noopener noreferrer">
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
23
    <img alt="Gitter" src="https://badges.gitter.im/liuyib/hexo-theme-stun.svg">
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
24
  </a>
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
25
</p>
26

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
27
[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)
28

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
29
## :sparkles: 演示
30

31
- [Liuyib's Blog](https://liuyib.github.io/)
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
32
- [弥枳's Blog](http://blog2.coor.top/)
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
33
- [轻尘's Blog](http://qcxitong.xyz/)
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
34
- [impressionyang's Blog](http://impressionyang.github.io)
C
cjpnice 已提交
35
- [cjpNiceの博客](http://cjpnice.gitee.io)
C
cjh0613 已提交
36
- [峡州仙士之页](https://cjh0613.gitee.io/blog/)
37

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
38
如果你正在使用 Stun 主题,并希望展示在这里,你只需修改 [README](https://github.com/liuyib/hexo-theme-stun/edit/master/README.md) 填入你的网站,然后提交 PR 即可。
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
39

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
40 41
## :crystal_ball: 特性

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
42
- 简洁 & 快速 & 易用 & **可定制性高**
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
43
- 响应式设计
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
44 45 46
- [二级导航菜单](https://liuyib.github.io/hexo-theme-stun/zh-CN/advanced/advanced-setting.html#二级导航菜单)
- 支持[图片懒加载](https://liuyib.github.io/hexo-theme-stun/zh-CN/advanced/advanced-setting.html#图片懒加载)
- 支持 [Pjax](https://github.com/defunkt/jquery-pjax)
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
47
- 支持 [PWA](https://developers.google.com/web/progressive-web-apps)
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
48 49
- 支持 [Fancybox](https://github.com/fancyapps/fancybox)
- 支持 [Quicklink](https://github.com/GoogleChromeLabs/quicklink)
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
50
- 支持 [MathJax](https://www.mathjax.org/)[KaTex](https://katex.org/)
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
51
- 支持 [Gitalk](https://github.com/gitalk/gitalk)[Valine](https://valine.js.org/)[Livere](https://livere.com/)[Disqus](https://disqus.com/)[Utterances](https://github.com/utterance/utterances) 评论
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
52 53 54 55 56
- 瀑布流式的[相册页面](https://liuyib.github.io/gallery/)
- 内置[谷歌广告](https://www.google.cn/adsense/start/),一键开启
- 代码高亮,[多种配色](https://liuyib.github.io/hexo-theme-stun/zh-CN/advanced/advanced-setting.html#代码高亮)可选
- 好看的[背景特效](https://liuyib.github.io/hexo-theme-stun/zh-CN/advanced/third-part.html#ribbon)
- 超详细[配置文档](https://liuyib.github.io/hexo-theme-stun/)
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
57

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
58
## :package: 安装
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
59

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
60
- 安装 Stun
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
61

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
62
  进入 Hexo 根目录,执行指令:
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
63

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
64
  ```bash
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
65 66
  $ git clone https://github.com/liuyib/hexo-theme-stun.git themes/stun
  ```
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
67

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
68
- 安装依赖 `hexo-renderer-pug`
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
69

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
70
  进入 Hexo 根目录,执行指令:
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
71

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
72
  ```bash
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
73
  $ npm install --save hexo-renderer-pug
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
74
  ```
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
75

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
76
## :hammer: 使用
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
77

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
78
修改 Hexo 根目录下的 `_config.yml` 文件:
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
79

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
80
```yml
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
81 82 83
theme: stun
```

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
84
然后,启动 Hexo 服务器:
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
85

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
86
```bash
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
87 88 89
$ hexo clean && hexo s
```

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
90
## :art: 更新
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
91

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
92
```bash
93
$ cd themes/stun
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
94

95
$ git pull
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
96 97
```

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
98
## :page_facing_up: 文档
99

100 101
请查看:[https://liuyib.github.io/hexo-theme-stun/zh-CN/](https://liuyib.github.io/hexo-theme-stun/zh-CN/)

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
102
## :question: 问题
103

104
如果遇到问题,首先请仔细阅读[文档](https://liuyib.github.io/hexo-theme-stun/zh-CN/),或者查看[常见问题](https://github.com/liuyib/hexo-theme-stun/blob/master/FAQ.md)。当以上的方法都无法帮助你时,再去提出 `issue`:hugs:。
105

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
106
## :computer: 浏览器支持
107

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
108
| <img src="https://raw.githubusercontent.com/liuyib/picBed/master/collection/20190723235410.png" alt="IE" width="32px" height="32px" /></br> IE | <img src="https://cdnjs.cloudflare.com/ajax/libs/browser-logos/35.1.0/edge/edge_64x64.png" alt="Edge" width="32px" height="32px" /></br> Edge | <img src="https://raw.githubusercontent.com/liuyib/picBed/master/collection/20190723235406.png" alt="Firefox" width="32px" height="32px" /></br> Firefox | <img src="https://raw.githubusercontent.com/liuyib/picBed/master/collection/20190723235407.png" alt="Chrome" width="32px" height="32px" /></br> Chrome | <img src="https://raw.githubusercontent.com/liuyib/picBed/master/collection/20190723235409.png" alt="Safari" width="32px" height="32px" /></br> Safari | <img src="https://raw.githubusercontent.com/liuyib/picBed/master/collection/20190723235411.png" alt="Opera" width="32px" height="32px" /></br> Opera |
109
| :---: | :---: | :---: |:---: | :---: | :---: |
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
110
| Not Supported | 12+ | 41+ | 45+ | 10+ | 32+ |
111

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
112
## :handshake: 开源协议
113

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
114
[MIT](https://github.com/liuyib/hexo-theme-stun/blob/master/LICENSE) Copyright (c) 2019 liuyib