summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 1091e76c6e4436dfd2b0120880b68bb7e2285410 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
![](banner.jpg)

<p align="center">
<img src="https://img.shields.io/badge/build-passing-brightgreen.svg?style=flat-square"> 
<img src="https://img.shields.io/badge/made%20with-%E2%9D%A4-ff69b4.svg?style=flat-square"> 
<a href="LICENSE"><img src="https://img.shields.io/badge/license-SATA-blue.svg?style=flat-square"></a> 
<a href="https://typecho.org"><img src="https://img.shields.io/badge/for-Typecho-blueviolet.svg?style=flat-square"></a> 
<a href="https://github.com/BigCoke233/miracles/releases"<img src="https://img.shields.io/badge/version-1.3.2-red.svg?style=flat-square"></a> 
<a href="https://github.com/BigCoke233/miracles/graphs/contributors"><img src="https://img.shields.io/github/contributors/BigCoke233/miracles?color=orange&style=flat-square"></a> 
<a href="https://github.com/BigCoke233/miracles/releases"><img src="https://img.shields.io/badge/version-1.4.1-red?style=flat-square"></a>
<p align="center"><strong>记录你心中的奇迹,书写你自己的篇章</strong></p>

---

## 特色
- 响应式 / 自适应设计
- Pjax 全站无刷新
- Ajax 评论无刷新
- 支持系统切换夜间模式
- 调用 bilibili API 显示追番页面
- 前台登录
- 图片懒加载
- 代码高亮 / 行号
- 不错的兼容性
    - 夜间模式下的 Pio 插件按钮样式
    - 夜间模式下的 Aplayer 播放器
    - Bilibili 外链长宽比例
- 良好的阅读体验
    - 阅读时长估计
    - 字数统计
    - 两种可供选择的字体(思源宋体/黑体)
- 不错的自定义性能
    - 两种可供选择的导航栏
    - 多种图片懒加载动画供选择
    - 黑白滤镜(哀悼模式)
- 灵活的友情链接功能
- 方便排版的短代码
- 后台设置备份

## 使用
1. Star 本项目(遵循 SATA 开源协议)
2. 下载**最新的 [Release](https://github.com/BigCoke233/miracles/releases)**
3. 解压后,**确认目录名为`Miracles`(M 大写)**
4. 将文件夹放入 Typecho 根目录下的`usr/themes/`
5. 到后台-外观-可用的主题中,启用主题
6. **根据 [wiki](http://mira.guhub.cn/)** 配置主题

<details><summary>使用开发版</summary><br>

直接下载仓库,或者使用 git 命令行进行克隆。
```git
$ git clone https://github.com/BigCoke233/miracles.git
```
> 不推荐使用开发版,因为可能有不确定的不稳定因素,并且不一定有有利改动<br>如果你使用开发版出现任何问题,欢迎通过 issue 反馈,在等待回复期间请使用发行版

</details>
<details><summary>遇到问题</summary><br>

如果在使用过程中遇到了任何问题,可以先阅读本主题的 [Wiki](http://mira.guhub.cn/),并进行一些简单的确认:清理浏览器缓存,更换网络环境,确保 Console 内没有提示访问不到文件等自身原因。如果你无法靠自己解决问题,可以尝试联系作者,但记住**开发者没有为你解决问题的义务,只是出于好心的帮助。**  
在确认你遇到的现象确实是一个 Bug 后,请在 [Issues](https://github.com/BigCoke233/miracles/issues) 提交问题,并为该问题尽可能的描述清楚,按照提供的 issue 模板进行填写,谢谢配合。

</details>
<details><summary>关于版权</summary><br>

主题基于 SATA 协议开源,使用前你需要给这个项目点一个 Star,使用或转发时**请保留版权信息**,禁止倒卖。若需二次开发后发布,请邮件通知我`hi#guhub.cn`,并保留原作者版权信息及仓库链接。同时,如果发现有侵权行为,请告知我,屡教不改者将被列入[黑名单](docs/black-list.md),删除版权的用户不会在遇到问题时受到来自作者的帮助,在后期可能会加入删除版权网站设置项失效的惩罚。

</details>

## 鸣谢
> 这些都是在开发过程中给予我帮助的项目和大佬!

### 开源项目
- [jQuery](https://github.com/jquery/jquery) - 若干开源项目和主题内一些 js 的前置
- [FancyBox](https://github.com/fancyapps/fancybox) - 文章图片灯箱
- [Highlight.js](https://github.com/highlightjs/highlight.js) - 代码高亮
- [Hightlight-line-numbers](https://github.com/wcoder/highlightjs-line-numbers.js) - 代码行号
- [Pjax](https://github.com/defunkt/jquery-pjax) - Pjax 预加载
- [Nprogress](https://github.com/rstacruz/nprogress) - Pjax 滚动条动画
- [OwO](https://github.com/DIYgod/OwO) - 评论 OwO 表情
- [LazyLoad](https://github.com/tuupola/lazyload) - 图片懒加载
- [Pangu.js](https://github.com/vinta/pangu.js) -分割中英文字符

### 贡献者
| 贡献者 | 贡献内容 |
| ------ | ------- |
| [@BigCoke233 (Eltrac)](https://github.com/BigCoke233) | 原作者 |
| [@outtimes](https://github.com/outtimes) | 提供各种有用的功能 |
| [@ohmyga233](https://github.com/ohmyga233) | 实现 Ajax 评论无刷新 |
| [@kengwang](https://github.com/kengwang) | 提供追番页面 |

## 相关
演示站点:[我的博客](https://guhub.cn)  |  以及 Sponsor 中的站点链接  
介绍文章:[Miracles —— 生为奇迹](https://guhub.cn/p/miracles.html)  
说明文档:[Wiki](http://mira.guhub.cn/)  
更新日志:[change-log.md](docs/change-log.md)  
更新计划:[plan.md](docs/plan.md)(包括已知的 Bug)  
侵权网站:[black-list.md](docs/black-list.md)

---

Copyright &copy; 2019-2020 [Eltrac](https://github.com/BigCoke233), released under [SATA License](https://github.com/zTrix/sata-license).