summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEltrac <45323514+BigCoke233@users.noreply.github.com>2019-12-15 11:26:57 +0800
committerGitHub <noreply@github.com>2019-12-15 11:26:57 +0800
commit8efde6f9b407eabc6f663e450fa1682d6c0b70ac (patch)
treeb620082005aa15d88d02db54dea4b08eaa7d8baf
parent9d30c8dd881bb89b5df996d184efe96eff67bb01 (diff)
✒️ Perf: 文案细节
-rw-r--r--README.md70
1 files changed, 39 insertions, 31 deletions
diff --git a/README.md b/README.md
index 30e00e6..924f70d 100644
--- a/README.md
+++ b/README.md
@@ -14,63 +14,71 @@
> **请下载 [Releases](https://github.com/BigCoke233/miracles/releases) 页面的最新发行包,使用前先看 [Wiki](https://github.com/BigCoke233/miracles/wiki),wiki 有的问题一律不解答;禁止删除主题版权信息**<br>同时,主题的 Telegram 频道已开启,可以获取主题最新消息,推送作者博客更新,点此加入:[Miracles News](https://t.me/eltracer)<br>开放了一个议题,用于~~民主~~决策主题的更新方向,点击 [这里](https://github.com/BigCoke233/miracles/issues/17) 进入
# 特色
-- 响应式/自适应设计
+- 响应式 / 自适应设计
- Pjax 全站无刷新
-- 夜间模式
+- 夜间模式 & 日落模式
- 前台配置面板
-- 前台登录
-- 代码高亮/行号
-- 内置 Live2d
-- 简洁大气的设计
-- 灵活的友链功能
+- 前台登录 / 快捷后台通道
+- 图片懒加载
+- 代码高亮 / 行号
+- 思源系列字体
+- 两种可供选择的导航栏(顶部导航栏 / 侧边栏)
+- 灵活的友情链接功能
- 方便排版的短代码
+- 后台设置备份
+- 文章浏览数 / 字数统计
+- 内置 Live2d(将在 1.3.0 版本移除)
+- 简洁大气的设计
- 文字可读性高
- 一个完善的 wiki(强调)
+- More to find
# 使用
-1. 下载最新的 [Release](https://github.com/BigCoke233/miracles/releases)
-2. 解压后,确认目录名为`Miracles`(M 大写)
+1. 下载**最新的 [Release](https://github.com/BigCoke233/miracles/releases)**
+2. 解压后,**确认目录名为`Miracles`(M 大写)**
3. 将文件夹放入`usr/themes`
4. 到后台启用主题
-5. 配置主题
+5. **根据 wiki** 配置主题
> 有问题请先查看 [Wiki](https://github.com/BigCoke233/miracles/wiki)
-<details>
-<summary><strong>使用开发版</strong></smmary>
-
-直接下载仓库,或者使用命令行进行克隆
+<details><summary>使用开发版</summary><br>
+
+直接下载仓库,或者使用 git 命令行进行克隆
```git
$ git clone https://github.com/BigCoke233/miracles
```
-> 不推荐使用开发版,因为可能有不确定的不稳定因素
+> 不推荐使用开发版,因为可能有不确定的不稳定因素,并且不一定有有利改动<br>如果你使用开发版出现任何问题,欢迎通过 issue 反馈,在等待回复期间请使用发行版
</details>
# 鸣谢
> 这些都是在开发过程中给予我帮助的项目和大佬!
## 开源项目
-- [jQuery](https://github.com/jquery/jquery)
-- [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)
-- [Nprogress](https://github.com/rstacruz/nprogress)
-- [OwO](https://github.com/DIYgod/OwO)
-- [Pjax](https://github.com/defunkt/jquery-pjax)
-- [LazyLoad](https://github.com/tuupola/lazyload)
-- [Pangu.js](https://github.com/vinta/pangu.js)
-## 大佬们
-[@ohmyga233](https://github.com/ohmyga233) |
-[@AlanDecode](https://github.com/AlanDecode) |
-[@gfwyuexia](https://github.com/gfwyuexia) |
-[@jrotty](https://github.com/jrotty)
+- [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)(分割中英文字符)
+## 大佬
+常提交 Pull Requests 的大佬:
+- [@outtimes](https://github.com/outtimes)(时光)
+
+在我需要帮助时给予回应的大佬:
+- [@ohmyga233](https://github.com/ohmyga233)(ohmyga)
+- [@AlanDecode](https://github.com/AlanDecode)(熊猫小 A)
+- [@gfwyuexia](https://github.com/gfwyuexia)(枂下)
+- [@jrotty](https://github.com/jrotty)(泽泽)
# 相关
-演示站点:[我的博客](https://guhub.cn)
+演示站点:[我的博客](https://guhub.cn) | 以及 Sponsor 中的站点链接
介绍文章:[Miracles —— 生为奇迹](https://guhub.cn/p/miracles.html)
说明文档:[Wiki](https://github.com/BigCoke233/miracles/wiki)
更新日志:[change-log.md](docs/change-log.md)
更新计划:[plan.md](docs/plan.md)(包括已知的 Bug)
-> 仓库开启了 Sponsor 功能,我会选取使用 Miracles 主题的高质量博客链接列入 Sponsor 内
# 版权
&copy; [Eltrac](https://github.com/BigCoke233) | Under MIT License