summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--docs/README-en.md59
-rw-r--r--docs/change-log.md78
-rw-r--r--docs/plan.md21
3 files changed, 158 insertions, 0 deletions
diff --git a/docs/README-en.md b/docs/README-en.md
new file mode 100644
index 0000000..455427e
--- /dev/null
+++ b/docs/README-en.md
@@ -0,0 +1,59 @@
+![](banner.jpg)
+![](https://img.shields.io/badge/build-passing-brightgreen.svg)
+![](https://img.shields.io/badge/made%20with-%E2%9D%A4-ff69b4.svg)
+![](https://img.shields.io/badge/license-MIT-blue.svg)
+![](https://img.shields.io/badge/for-Typecho-blueviolet.svg)
+![](https://img.shields.io/badge/version-1.2.0-red.svg)
+> 🙌 Born to be the Miracles.
+
+Language: [简体中文](README.md) | English
+
+> Notice: This theme is only for [Typecho](https://github.com/typecho/typecho).
+
+# Feature
+- Responsive Web design
+- Pjax
+- LazyLoad
+- Code Highlight by Prism.js
+- Change font-family and font-size when viewing pages
+- Use emotional pictures in comments
+- Live2d
+- A nice dark theme
+- Two interesting filters
+- Two kinds of Nav
+- Custom excerpt when posting
+- Twenty random banner for articles
+- ~~Lightweight (4MB)~~
+
+# Usage
+- Star, please!
+- Download the latest release.
+- Change the name of the folder into `Miracles`
+- Put it into `usr/themes`
+- Start using after reading the [wiki](https://github.com/BigCoke233/miracles/wiki)
+> Sorry, there's no English edition of the wiki now. Maybe you can help me.
+
+# Thanks!
+- [jQuery](https://github.com/jquery/jquery)
+- [FancyBox](https://github.com/fancyapps/fancybox)
+- [Prism.js](https://github.com/PrismJS/prism)
+- [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)
+
+# Links
+Demo: [My Blog](https://guhub.cn)
+Introduction: [Miracles —— 生为奇迹](https://guhub.cn/p/miracles.html)
+Change-log: [change-log.md](https://github.com/BigCoke233/miracles/blob/master/change-log.md)
+Plan: [plan.md](https://github.com/BigCoke233/miracles/blob/master/plan.md)
+> All above is in Chinese.
+
+# Lincense
+© under MIT License.
diff --git a/docs/change-log.md b/docs/change-log.md
new file mode 100644
index 0000000..f3730db
--- /dev/null
+++ b/docs/change-log.md
@@ -0,0 +1,78 @@
+# 更新日志
+## Ver.1.2.1 Clear
+- 添加:`alertSend()`有一个新参数 auto (boolean),决定弹出框是否自动关闭
+- 添加:控制台输出版权信息
+- 添加:密码保护文章的表单样式
+- 优化:左侧抽屉栏的自适应和样式微调
+- 优化:调整滚动条粗细,现在能被清楚地看到了
+- 优化:复制文本后弹出的版权提示能够自动关闭了
+- 优化:展开抽屉栏后,点击遮罩层就能关闭
+- 优化:舍弃 onclick 属性,改用事件监听器
+- 优化:移动端,页面跳转完毕后导航栏才会收起
+- 优化:只有首页才会弹出公告提示
+- 优化:压缩 html 页面
+- 移除:左侧抽屉栏的搜索框
+- 移除:是否固定导航栏设置
+- 移除:后台公告
+- 移除:说说功能(之后调整好可能会回归)
+- 调整:加载 Live2D 的语句移动到 `l2dwidget.min.js`
+- 修复:禁止滑动后自动返回顶部
+- 修复:一些元素在夜间模式下未正常显示
+- 修复:未使用 Live2D 时,控制台报错
+- 修复:没有评论的页面找不到 owo 容器,导致控制台报错
+
+## Ver.1.2.0 Sky's Mirages
+- 添加:前台设置面板
+- 添加:内置两只可调戏的猫咪(https://www.jianshu.com/p/57a4deab12cc)
+- 添加:文章编写时间超过 90 天,显示“可能过期”的提示
+- 添加:左侧抽屉栏,可与顶部导航栏进行切换
+- 添加:关于页面自定义模板,支持社交按钮
+- 添加:进站公告提示
+- 添加:用户复制内容后,弹出信息提醒保留版权信息
+- 添加:自定义提示信息,用`alertSend("内容")`召唤信息栏
+- 优化:Cookies 储存夜间模式
+- 优化:全局自动分离英文/半角字符和中文,优化阅读体验(Pangu.js)
+- 优化:代码块最高高度为 80vh(屏幕高度的 80%)
+- 修复:文字卡片标题部分字母下半部分显示不完整
+- 修复:代码块行号不对齐
+- 修复:友链盒子两端未对齐
+- 修复:一些元素在夜间模式下未正常显示
+- 修复:CDN 静态资源加速启用后 css 及 js 404
+
+## Ver.1.1.2 Preheat
+- 新增:可以在后台开启 CDN 静态资源加速(调用 JSdelivr)
+- 新增:“哀悼模式”,将网站变为黑白,Pray for 京阿尼
+- 新增:可以在后台切换 无衬线字体/衬线字体(调用 Google Fonts)
+- 新增:备份模板设置项功能(来自[QQ爹](https://qqdie.com))
+- 新增:额外的 10 张随机缩略图
+- 优化:分离主题设置(Options.php)和其他函数(functions.php)
+- 优化:评论内容在不同分辨率下不同的字体大小
+- 优化:Meting 插件播放器在夜间模式下的显示
+- 优化:文章缩略图容易重复的问题
+- 优化:设置项分类+船新的设置页面样式
+- 修复:自定义 CSS 重复输出
+- 修复:之前更新一直没有修改版本号的问题
+
+## Ver.1.1.1 The Kids Are Alright
+- 修复:博主评论的子评论全部变成蓝色背景标识的 BUG
+- 修复:Meting 插件无法正常解析的问题
+- 修复:评论分页样式缺失的 BUG
+- 修复:说说页面夜间模式下显示的问题
+- 修复:Pjax 跳转后无法进行登录(其实就是给了个刷新提示而已233)
+- 修复:小屏幕上子评论被挤成一条的问题(虽然还是丑得不能看)
+- 修复:回复评论会激活 Pjax 导致返回顶部的问题
+- 优化:规范了代码结构
+
+## Ver.1.1.0 Various Ways
+- 新增:图片懒加载功能
+- 新增:“说说/动态”页面
+- 新增:一些便于排版的短代码(稍后更新 WIKI)
+- 新增:支持自定义文章摘要
+- 优化:分离移动端和电脑端导航栏
+- 优化:一些元素在夜间模式下的显示
+- 优化:船新的评论区样式
+- 优化:分离夜间模式 CSS 文件
+- 优化:现在 OwO 表情不会被压扁了
+- 优化:细调了某些元素的样式
+- 修复:呼出 FancyBox 自动返回顶部
+
diff --git a/docs/plan.md b/docs/plan.md
new file mode 100644
index 0000000..269d208
--- /dev/null
+++ b/docs/plan.md
@@ -0,0 +1,21 @@
+# 更新计划
+## 增加
+- [ ] 实现 Ajax 评论无刷新(目前还是半成品)
+- [ ] 添加文章目录
+- [ ] 后台检测主题更新
+- [ ] 根据时间自动打开夜间模式
+- [ ] 追番页面
+- [ ] 文章字数统计
+
+## 优化
+- [ ] 实现表情解析,告别臃肿的 img 表情
+- [ ] 前台的字体大小
+- [ ] 兼容 Pjax 的前台登录
+- [ ] 撸猫看板在各种分辨率下的显示
+- [ ] 评论区的样式
+- [ ] 页脚的设计
+
+## 修复
+- [x] 左侧边栏太大导致小屏幕显示不完整
+
+> 如果有什么建议和问题,欢迎到 issues 页面反馈