README.md 6.8 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">
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
3
    <img src="./source/images/icons/stun-logo.svg" alt="Stun Logo" width="100">
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
4 5
  </a>
</p>
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
6

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

<p align="center">
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
10
  <a href="http://standardjs.com" target="_blank" rel="noopener noreferrer">
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
11
    <img alt="js-standard-style" src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg">
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
12
  </a>
13
  <a href="http://commitizen.github.io/cz-cli/" target="_blank" rel="noopener noreferrer">
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
14
    <img alt="Commitizen friendly" src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg">
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
15
  </a>
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
16 17 18
  <a href="https://app.fossa.com/projects/git%2Bgithub.com%2Fliuyib%2Fhexo-theme-stun?ref=badge_shield">
    <img alt="FOSSA Status" src="https://app.fossa.com/api/projects/git%2Bgithub.com%2Fliuyib%2Fhexo-theme-stun.svg?type=shield"/>
  </a>
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
19 20
  <a href="https://libraries.io/github/liuyib/hexo-theme-stun#dependencies" target="_blank" rel="noopener noreferrer">
    <img alt="Dependency status" src="https://img.shields.io/librariesio/github/liuyib/hexo-theme-stun">
21
  </a>
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
22
  <a href="https://github.com/liuyib/hexo-theme-stun/blob/master/LICENSE" target="_blank" rel="noopener noreferrer">
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
23
    <img alt="GitHub LICENSE" src="https://img.shields.io/github/license/liuyib/hexo-theme-stun.svg">
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
24
  </a>
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
25
  <br>
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
26
  <a href="https://hexo.io/zh-cn/" target="_blank" rel="noopener noreferrer">
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
27
    <img alt="Hexo version" src="https://img.shields.io/badge/hexo-%3E%3D4.0-blue.svg">
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
28 29
  </a>
  <a href="https://github.com/liuyib/hexo-theme-stun/releases" target="_blank" rel="noopener noreferrer">
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
30
    <img alt="GitHub release" src="https://img.shields.io/github/release/liuyib/hexo-theme-stun.svg">
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
31
  </a>
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
32
  <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(文一) 已提交
33
    <img alt="Gitter" src="https://badges.gitter.im/liuyib/hexo-theme-stun.svg">
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
34
  </a>
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
35
</p>
36

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
37
语言: [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)
38

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

41
- [Liuyib's Blog](https://liuyib.github.io/)
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
42
- [弥枳's Blog](http://blog2.coor.top/)
43 44
- [轻尘's Blog](https://qcxitong.xyz/)
- [impressionyang's Blog](https://impressionyang.github.io)
C
cjh0613 已提交
45
- [峡州仙士之页](https://cjh0613.gitee.io/blog/)
46
- [Cheeks's Blog](https://www.cheeks.top/)
L
Lingan 已提交
47
- [lingan1996's Blog](https://www.lingan1996.top)
48
- [MikyMing's Blog](https://mikyming.online/)
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
49
- [Yichangkong's Blog](https://yichangkong.github.io/)
S
Sakurai Kaede 已提交
50
- [樱井枫的小博客](https://sakurai.in/)
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
51
- [Gemini's Blog](https://geminiplanet.cn/)
52

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

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

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
57
- 简洁 & 快速 & 易用 & **可定制性高**
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
58
- 响应式设计
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
59 60 61
- [二级导航菜单](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(文一) 已提交
62
- 支持 [PWA](https://developers.google.com/web/progressive-web-apps)
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
63 64
- 支持 [Fancybox](https://github.com/fancyapps/fancybox)
- 支持 [Quicklink](https://github.com/GoogleChromeLabs/quicklink)
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
65
- 支持 [MathJax](https://www.mathjax.org/)[KaTex](https://katex.org/)
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
66
- 支持 [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(文一) 已提交
67 68 69 70 71
- 瀑布流式的[相册页面](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(文一) 已提交
72

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

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
75
- 安装 «Stun»
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
76

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

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
79
  ```bash
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
80 81
  $ git clone https://github.com/liuyib/hexo-theme-stun.git themes/stun
  ```
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
82

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

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

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
87
  ```bash
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
88
  $ npm install --save hexo-renderer-pug
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
89
  ```
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
90

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

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

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
95
```yml
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
96 97 98
theme: stun
```

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

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
101
```bash
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
102 103 104
$ hexo clean && hexo s
```

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

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
107
```bash
108
$ cd themes/stun
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
109

110
$ git pull
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
111 112
```

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
113
## :page_facing_up: 文档
114

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

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

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

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
121 122
## :handshake: 贡献

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
123
在提出 Pull request 之前,请务必先阅读[贡献指南](https://liuyib.github.io/hexo-theme-stun/zh-CN/contribute/contribute.html)
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
124 125 126 127 128 129 130

感谢所有为 «Stun» 做出贡献的人!

<a href="https://github.com/liuyib/hexo-theme-stun/graphs/contributors">
  <img src="https://opencollective.com/hexo-theme-stun/contributors.svg?width=980">
</a>

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

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
133
| <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 |
134
| :---: | :---: | :---: |:---: | :---: | :---: |
EvanOne(文一)'s avatar
EvanOne(文一) 已提交
135
| Not Supported | 12+ | 41+ | 45+ | 10+ | 32+ |
136

EvanOne(文一)'s avatar
EvanOne(文一) 已提交
137
## :page_with_curl: 开源协议
138

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

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fliuyib%2Fhexo-theme-stun.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fliuyib%2Fhexo-theme-stun?ref=badge_large)